Skip to content

Commit

Permalink
Readme fixes & improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
vdjagilev committed Sep 5, 2020
1 parent 5c39e61 commit af30870
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Changelog
=========

## v1.2.1

* README fixes & improvements

## v1.2.0

* Added sorting support
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Download application, you can use git for it:
```
git clone [email protected]:vdjagilev/nmap2md.git
cd nmap2md
nmap -A -T4 -oX test [target]
```

Example which parses nmap XML and outputs Markdown tables
Expand Down Expand Up @@ -38,13 +37,14 @@ Columns and row cells definition should be divided by `,`.
* `--sort` is for sorting.
* Default: `Port;asc`
* Can use any column that is defined in `-c`
* `asc` & `desc` options, if none is provided: `asc by default
* `asc` & `desc` options, if none is provided: `asc` by default
* `--print-empty` some port scanning results are empty and those are not displayed. However if there is a need to print empty sets, this option allows this.
* Default: False

## Output example

Example was taken from https://nmap.org/book/output-formats-xml-output.html and used this command:
An example with many options and MD support in table cells (service values are *italic*).
XML file was taken from https://nmap.org/book/output-formats-xml-output.html and this command was used:

```
./nmap2md.py test.xml -c "Port,State,Service,Version" --hs 4 --rc "[port.number]/[port.protocol],[state],*[service.name]*,[service.product] [service.version]"
Expand Down
2 changes: 1 addition & 1 deletion nmap2md.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import columns_definition

__version__ = "1.2.0"
__version__ = "1.2.1"

parser = OptionParser(usage="%prog [options] file.xml", version="%prog " + __version__)

Expand Down

0 comments on commit af30870

Please sign in to comment.