New README.md

README.md

@@ -1,70 +1,62 @@
-# FORMS HUNTER
+# ✨ Funter - Forms Hunter
+
+Funter tool extract all forms and inputs found in a list of urls.
+
+## ⭐ Features
+
+## 💥 Key Benefits
+
+
+# 💻 Install
 
-This tool hunts all forms and inputs found in a list of urls.
 
 ## Virtual environment
 
-To create a python virtual environment:
 ```
 sudo apt install python3-venv
+```
+
+To create a python virtual environment:
+```
 python3 -m venv venv
 source venv/bin/activate
-python3 -m pip install -r setup/requirements.txt
+python3 -m pip install -r requirements.txt
 ```
 
 ## Setup
 
 Install requirements:
 ```
-cd setup
-chmod +x setup.sh
-sudo bash setup.sh
+chmod +x setup/setup.sh
+sudo bash setup/setup.sh
 ```
 
-## Execution
+# 🎓 Usage
 
 First start the docker database server:
 ```
 cd setup
 sudo bash server.sh
 ```
 
-
 ### Example 1 - Url
 
 ```
-python3 formshunter.py -r -u https://www.google.com -o outputs/output.csv -v
+python3 funter.py -u https://www.google.com -o outputs/output.csv -v
 ```
 
-- -r: Reset database
-- -U: Search forms on url.
-- -o: Dump 'form' document ("table") to CSV file.
-- -v: Verbose.
-
-
-![Command output](/images/formhunter_url_example.png)
-
 ### Example 2 - File with list of urls
 
 ```
-python3 formshunter.py -r -U data/urls.txt -o outputs/output.csv -v
+python3 funter.py -U data/urls.txt -o outputs/output.csv -v
 ```
 
-- -r: Reset database
-- -U: Search forms on urls within urls.txt
-- -o: Dump 'form' document ("table") to CSV file.
-- -v: Verbose.
-
-![Command output](/images/formhunter_file_example.png)
-
 ### Example 3 - Just reset database
 
 ```
-python3 formshunter.py -r
+python3 funter.py -r
 ```
 
-- -r: Reset database
-
 ## Tool options
 
 Directory | Description
@@ -85,7 +77,26 @@ DB credentials in project `.env` file.
 
 ![Database data](/images/database_data.png)
 
-# Social
+
+# 🛠️ Configuration
+
+You can change the output formats and other settings through the [config.yaml](config%2Fconfig.yaml) file.
+
+
+# 💬 Change Log
+
+- **25/06/2023** - XNP v1.0.0
+ - New tool name "Funter".
+ - New "config.yaml" file configuration.
+ - Refactored code.
+ - Added a module for automatic version checking and updating. XtremeNmapParser will now check if it's running the latest version at startup and update itself if a new version is available.
+
+
+# 📜 License
+
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for more information.
+
+# 🎉 Let's Get Social!
 
 * **Website:** [https://xtormin.com](https://xtormin.com)
 * **Linkedin:** [https://www.linkedin.com/in/xtormin/](https://www.linkedin.com/in/xtormin/).