Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abut0n committed May 16, 2024
1 parent 99077ae commit 216ed7c
Showing 1 changed file with 5 additions and 20 deletions.
25 changes: 5 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# nmapx
Fast and reliable rust implementation of xml to json parser for nmap scans.
A fast and reliable Rust tool for converting Nmap scan results from XML to JSON or CSV formats.

```bash
>$ nmapx --help
nmap serializer & deserializer

Usage: nmapx [OPTIONS] <NMAP>...
Expand All @@ -25,28 +26,12 @@ You can easily install this package using Cargo, Rust's package manager and buil
cargo install nmapx
```

## How to use it

```bash
nmapx nmap_report.xml
[WRN] Use with caution. You are responsible for your actions.
#### ... or use nmapx in your projects as lib

```sh
cargo add nmapx
```

### ... or use nmapx in your projects as lib

```rust
use nmapx::from_str;

fn main() {

let file: String = std::fs::read_to_string(xml).unwrap();
let scan: nmapx::Scan = nmapx::from_str(&file).unwrap();
let j = serde_json::to_string(&scan).unwrap();

println!("{}", j);
}
````
# Contribute

Contributions are always welcome! Please create a PR to add Github Profile.
Expand Down

0 comments on commit 216ed7c

Please sign in to comment.