Skip to content

Commit ad3cc0c

Browse files
committed
docs: update readme
1 parent 82f5bcb commit ad3cc0c

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,16 @@ A tool that allows you to convert NMAP XML output to html/csv/json/markdown.
1111
## Table of Contents
1212

1313
- [NMAP-Formatter](#nmap-formatter)
14-
- [Table of Contents](#table-of-contents)
15-
- [Usage](#usage)
16-
- [Flags](#flags)
17-
- [Output Related Flags](#output-related-flags)
14+
- [Table of Contents](#table-of-contents)
15+
- [Usage](#usage)
16+
- [Flags](#flags)
17+
- [Output Related Flags](#output-related-flags)
1818
- [Installation](#installation)
1919
- [Using Go](#using-go)
20-
- [Download Binary](#download-binary)
21-
- [Compile](#compile)
22-
- [Example](#example)
20+
- [Docker](#docker)
21+
- [Download Binary](#download-binary)
22+
- [Compile](#compile)
23+
- [Example](#example)
2324

2425
## Usage
2526

@@ -118,12 +119,20 @@ nmap-formatter [nmap.xml] json | jq '.Host[]? | . as $host | .Ports?.Port[]? | s
118119
go install github.com/vdjagilev/nmap-formatter@latest
119120
```
120121

122+
### Docker
123+
124+
No installation needed, just run `docker run`:
125+
126+
```
127+
docker run -v /path/to/xml/file.xml:/opt/file.xml ghcr.io/vdjagilev/nmap-formatter:latest /opt/file.xml json
128+
```
129+
121130
### Download Binary
122131

123132
Choose version from Release page and download it:
124133

125134
```
126-
curl https://github.com/vdjagilev/nmap-formatter/releases/download/v0.1.0/nmap-formatter-linux-amd64.tar.gz --output nmap-formatter.tar.gz -L
135+
curl https://github.com/vdjagilev/nmap-formatter/releases/download/v0.3.0/nmap-formatter-linux-amd64.tar.gz --output nmap-formatter.tar.gz -L
127136
tar -xzvf nmap-formatter.tar.gz
128137
./nmap-formatter --help
129138
```

0 commit comments

Comments
 (0)