Skip to content

Commit

Permalink
Minor readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
vdjagilev authored Jul 23, 2022
1 parent 147c5ea commit 5c26510
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ HTML:
Graphviz:
![nmap-example-graphviz](docs/images/example-dot.png)

A tool that allows you to convert NMAP XML output to html/csv/json/markdown.
A tool that allows you to convert NMAP XML output to html/csv/json/markdown/dot.

## Installation

Expand All @@ -28,7 +28,7 @@ All other options can be found on [Installation Wiki page](https://github.com/vd
## Usage

```bash
nmap-formatter [html|csv|md|json] [path-to-nmap.xml] [flags]
nmap-formatter [html|csv|md|json|dot] [path-to-nmap.xml] [flags]
```

Or alternatively you can read file from `stdin` and parse it
Expand Down Expand Up @@ -57,6 +57,13 @@ nmap-formatter json [path-to-nmap.xml]
cat nmap.xml | nmap-formatter json
```

or Graphviz (dot)

```bash
cat example.xml | nmap-formatter dot | dot -Tsvg > test.svg
# open test.svg with browser
```

More examples can be found on [Usage Wiki page](https://github.com/vdjagilev/nmap-formatter/wiki/Usage)

### Flags
Expand Down

0 comments on commit 5c26510

Please # to comment.