From 216ed7ccf74b945fcfda8f65462746ec3b7b747c Mon Sep 17 00:00:00 2001
From: abut0n <marcuccio.dev@gmail.com>
Date: Thu, 16 May 2024 14:27:32 +0200
Subject: [PATCH] Update README.md

---
 README.md | 25 +++++--------------------
 1 file changed, 5 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 450869b..fb30f15 100644
--- a/README.md
+++ b/README.md
@@ -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>...
@@ -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.