Update README.md

README.md

@@ -1,14 +1,32 @@
-# Hack Overviewer Burp Extension
+<h4 align="center">Burp File Writer Extension</h4>
 
-Posts every URL to specified URL in settings..
+<p align="center">This burp extension writes all your requests in your burp software directory /filewriter folder that you can use later to do automated file scanning, etc.</p>
 
-## Building
-open project in NetBeans
-Run -> Build
-Output: dist/xxx.jar
+## Key Features
 
-With DomainName and FullURL
+* Writes requests in to folder
+* Writes requests / response data in to folder into .data file
 
-curl -d '{"domain":"101992-42.chat.api.drift.com","type":"4","params":"{access_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3MzQ3ODYxNDgwIiwiY2xpZW50SWQiOiJmNnp1aXpkeWh4cm03ciIsInVzZXJJZFR5cGUiOiJMRUFEIiwic2NvcGUiOiJsZWFkIiwiaXNzIjoiMTAxOTkyIiwiZXhwIjoxNjM1NzgxNTg0LCJpYXQiOjE2MDQyNDU1ODR9.QEGfTIf01GgF1zVMq8v7f-LXDi1LzqxLp8oHA7ZVbg1BML7E7o7JGKB-lKMnm-N4EcLv_fpAG7e5Ads7mlFdKA}","method":"POST", "url":"https://101992-42.chat.api.drift.com:443/api/auth", "hash":""}' -H "Content-Type: application/json" -X POST http://localhost/test.php
+## Known issues
 
-curl -d '{"domain":"presence.api.drift.com","type":"0","params":"{}","method":"OPTIONS", "url":"https://presence.api.drift.com:443/api/auth", "hash":""}' -H "Content-Type: application/json" -X POST http://localhost/test.php
+* Long URL's trigger error: filename to long
+* website index page not written eg: example.com
+
+## Download
+
+You can [download](https://github.com/arturssmirnovs/burp-file-writer-extension/releases/tag/1.0) the latest version here.
+
+## Demo
+
+[Watch demo video](https://youtu.be/fCTL4Na1rYY)
+
+## Credits
+
+This software uses the following open source packages:
+
+- [Burp Extender](https://portswigger.net/burp/documentation/desktop/tools/extender)
+- [Simple Json java](https://code.google.com/archive/p/json-simple/)
+
+## License
+
+MIT