Skip to content

Commit 5e6d077

Browse files
Update README.md
1 parent bca044a commit 5e6d077

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src=".github/workflows/assets/images/dmarc.jl-logo.jpg" width=15% height=15%>
33
</div>
44

5-
<h1 align="center">DMARC.jl</h1>
5+
<h1 align="center">DMARCParser.jl</h1>
66

77
<!-- badges: start -->
88
<div align="center">
@@ -20,13 +20,13 @@
2020
</div>
2121
<!-- badges: end -->
2222

23-
## What is DMARC.jl?
24-
DMARC.jl is a specialized Julia package designed to processes DMARC aggregate reports, typically in XML format, transforming them into a more human-readable and interpretable format. This transformation allows users to efficiently analyze and gain valuable insights into their domain's email activity, ultimately helping them take proactive steps to ensure email security and prevent malicious activities.
23+
## What is DMARCParser.jl?
24+
`DMARCParser.jl` is a specialized Julia package designed to processes DMARC aggregate reports, typically in XML format, transforming them into a more human-readable and interpretable format. This transformation allows users to efficiently analyze and gain valuable insights into their domain's email activity, ultimately helping them take proactive steps to ensure email security and prevent malicious activities.
2525

2626
<br />
2727

2828
## Functions available in DMARC.jl
29-
The following table provides an overview of the functions that can be used in DMARC.jl.
29+
The following table provides an overview of the functions that can be used in DMARCParser.jl.
3030

3131
| Function | Description |
3232
| ------------- | ------------- |
@@ -36,27 +36,27 @@ The following table provides an overview of the functions that can be used in DM
3636

3737
<br />
3838

39-
## How to use DMARC.jl
39+
## How to use DMARCParser.jl
4040

4141
### Installation
42-
You can install the latest **DMARC.jl** release with Julia's package manager:
42+
You can install the latest **DMARCParser.jl** release with Julia's package manager:
4343

4444
```julia-repl
4545
]
46-
add DMARC
46+
add DMARCParser
4747
```
4848

4949
or
5050

5151
```julia
5252
using Pkg
53-
Pkg.add("DMARC")
53+
Pkg.add("DMARCParser")
5454
```
5555

5656
### Usage
57-
DMARC.jl can be executed with just three lines of code.
57+
DMARCParser.jl can be executed with just three lines of code.
5858
```julia
59-
using DMARC
59+
using DMARCParser
6060
xml_file_name_and_path = "data\dmarc_aggregate_report.xml"
6161
dmarc_report = dmarc(xml_file_name_and_path)
6262
```
@@ -69,7 +69,7 @@ This will return a DataFrame similar to the one below:
6969

7070
To add some formatting like converting *begin* and *end* to DateTime format, use the dmarc_formatted function:
7171
```julia
72-
using DMARC
72+
using DMARCParser
7373
xml_file_name_and_path = "data\dmarc_aggregate_report.xml"
7474
dmarc_report = dmarc_formatted(xml_file_name_and_path)
7575
```
@@ -78,7 +78,7 @@ dmarc_report = dmarc_formatted(xml_file_name_and_path)
7878

7979
Should you just want the raw data, use the get_dmarc_data function:
8080
```julia
81-
using DMARC
81+
using DMARCParser
8282
xml_file_name_and_path = "data\dmarc_aggregate_report.xml"
8383
dmarc_raw = get_dmarc_data(xml_file_name_and_path)
8484
```
@@ -118,15 +118,15 @@ Here's what each of the tags means in your provided DMARC report
118118

119119
<br />
120120

121-
## DMARC compatible formats
121+
## DMARCParser compatible formats
122122
The DMARC Aggregare Reports sent from the following domains (or their associated organizations) have been thoroughly tested to work with the DMARC.jl package:
123123
- google.com
124124
- Outlook.com
125125
- Mail.Ru
126126
- zoho.com
127127
- iphmx.com
128128

129-
However, DMARC.jl is robust enough to work with any other properly formatted DMARC XML files.
129+
DMARCParser.jl is robust enough to work with any other properly formatted DMARC XML files.
130130

131131
<br />
132132

@@ -138,11 +138,11 @@ However, DMARC.jl is robust enough to work with any other properly formatted DMA
138138

139139
## Licensing
140140

141-
``DMARC.jl`` is released under the terms of the MIT License. Please refer to the <a href="https://github.com/analyticsinmotion/DMARC.jl/blob/main/LICENSE">LICENSE</a> file for full details.
141+
``DMARCParser.jl`` is released under the terms of the MIT License. Please refer to the <a href="https://github.com/analyticsinmotion/DMARCParser.jl/blob/main/LICENSE">LICENSE</a> file for full details.
142142

143143
This project also includes third-party packages distributed under the MIT license, including XML.jl and DataFrames.jl.
144144

145-
The full NumPy and Pandas licenses can be found directly in the following source codes:
145+
The full XML.jl and DataFrames.jl licenses can be found directly in the following source codes:
146146

147147
- XML.jl - <a href="https://github.com/JuliaComputing/XML.jl/blob/main/LICENSE">https://github.com/JuliaComputing/XML.jl/blob/main/LICENSE</a>
148148
- DataFrames.jl - <a href="https://github.com/JuliaData/DataFrames.jl/blob/main/LICENSE.md">https://github.com/JuliaData/DataFrames.jl/blob/main/LICENSE.md</a>

0 commit comments

Comments
 (0)