Update README.md

README.md

@@ -1,22 +1,47 @@
-# Arjun
-Arjun is a python script for finding hidden GET & POST parameters using regex and bruteforce.
 
-### Dependencies
+<h1 align="center">
-- requests
+  <br>
-- threading
+  <a href="https://github.com/s0md3v/Arjun"><img src="https://image.ibb.co/c618nq/arjun.png" alt="Arjun"></a>
+  <br>
+  Arjun
+  <br>
+</h1>
 
-### Usages
+<h4 align="center">Parameter Discovery Suite</h4>
-Here's how you can scan a webpage for get parameters
-```
-python arjun.py -u http://example.com/index.php --get
-```
-For POST, just use the <b>--post</b> flag.
-To specify the number of threads you can use the <b>--threads</b> option as following:
-```
-python arjun.py -u http://example.com/index.php --get --threads 4
-```
-Here's a screenshot you can fap to:</br>
-<img src='https://i.imgur.com/7BQv5qa.png' />
 
-#### License
+<p align="center">
-<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
+  <a href="https://github.com/s0md3v/Arjun/releases">
+    <img src="https://img.shields.io/github/release/s0md3v/Arjun.svg">
+  </a>
+  <a href="https://github.com/s0md3v/Arjun/issues?q=is%3Aissue+is%3Aclosed">
+      <img src="https://img.shields.io/github/issues-closed-raw/s0md3v/Arjun.svg">
+  </a>
+</p>
+
+![demo](https://image.ibb.co/gDETnq/Screenshot-2018-11-10-04-55-31.png)
+
+### Usage
+#### Discover parameters
+
+To find `GET` parameters, you can simply do:
+`python3 arjun.py -u https://api.example.com/endpoint --get`
+Similarly, you have to use `--post` to find `POST` parameters.
+
+#### Multi-threading
+Arjun uses 2 threads by default but you can tune its performance according to your network connection.
+
+`python3 arjun.py -u https://api.example.com/endpoint --get -t 22`
+
+#### Delay between requests
+You can delay the request by using the `-d` option as follows:
+`python3 arjun.py  -u https://api.example.com/endpoint --get -d 2`
+
+#### Adding HTTP Headers
+Using the `--headers` switch will open an interactive prompt where you can paste your headers. Press `Ctrl + S` to save and procced.
+
+![headers](https://image.ibb.co/jw5NgV/Screenshot-2018-10-27-18-45-32.png)
+
+> **Note:** Arjun uses `nano` as the default editor for the prompt but you can change it by tweaking `/core/prompt.py`.
+
+### Installation & Compatibility
+Arjun works with python >= 3.4