Arjun 1.4 release (Resolves #8)

- Added `JSON` support
- Fixed a major bug in detection logic
- `-o` option to save result to a file
- `--urls` option to scan list of URLs
- Ability to supply HTTP headers from CLI

Author: s0md3v

CHANGELOG.md

@@ -0,0 +1,18 @@
+#### 1.4
+- Added `JSON` support
+- Fixed a major bug in detection logic
+- `-o` option to save result to a file
+- `--urls` option to scan list of URLs
+- Ability to supply HTTP headers from CLI
+
+#### 1.3
+- improved logic
+- detection by plain-text content matching
+- `--include` switch to include persistent data
+- fixed a bug that caused user supplied HTTP headers to have no effect
+
+#### 1.2-beta
+- Drastic performance improvement (x50 faster)
+
+#### 1.1
+Initial stable release

README.md

@@ -18,60 +18,41 @@
   </a>
 </p>
 
-![demo](https://i.ibb.co/n0XdvZW/Screenshot-2019-04-07-20-08-04.png)
+![demo](https://i.ibb.co/0V6ymPy/Screenshot-2019-04-12-18-17-49.png)
+
+### Introduction
+Web applications use parameters (or queries) to accept user input, take the following example into consideration
+
+`http://api.example.com/v1/userinfo?id=751634589`
+
+This URL seems to load user information for a specific user id, but what if there exists a parameter named `admin` which when set to `True` makes the endpoint provide more information about the user?\
+This is what Arjun does, it finds valid HTTP parameters with a huge default dictionary of 25,980 parameter names.
+
+The best part? It takes less than 30 seconds to go through this huge list while making just 30-35 requests to the target.\
+Want to know how Arjun does that? [Here's how](https://github.com/s0md3v/Arjun/wiki/How-Arjun-works%3F).
 
 ### Features
 - Multi-threading
-- 4 modes of detection
+- Thorough detection
 - A typical scan takes 30 seconds
 - Regex powered heuristic scanning
 - Huge list of 25,980 parameter names
 - Makes just 30-35 requests to the target
 
-### Usage
-
 > **Note:** Arjun doesn't work with python < 3.4
 
-#### Discover parameters
-
-To find `GET` parameters, you can simply do:
-
-`python3 arjun.py -u https://api.example.com/endpoint --get`
-
-Similarly, 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`
-
-#### Including presistent data
-Let's say you have an API key that you need to send with every request, to tell Arjun to do that you can use the `--include` option as follows:
-
-`python3 arjun.py  -u https://api.example.com/endpoint --get --include 'api_key=xxxxx'`
-
-OR
-
-`python3 arjun.py  -u https://api.example.com/endpoint --get --include '{"api_key":"xxxxx"}'`
-
-To include multiple parameters, use `&` to seperate them or pass them as a valid json object.
-
-#### JSON Output
-You can save the result in a JSON format by using the `-o` as follows:
-
-`python3 arjun.py -u https://api.example.com/endpoint --get -o result.json`
-
-#### Adding HTTP Headers
-Using the `--headers` switch will open an interactive prompt where you can paste your headers. Press `Ctrl + S` to save and `Ctrl + X` to procced.
+#### How to use Arjun?
 
-![headers](https://image.ibb.co/jw5NgV/Screenshot-2018-10-27-18-45-32.png)
+A detailed usage guide is available on [Usage](https://github.com/s0md3v/Arjun/wiki/Usage) section of the Wiki.\
+An index of options is given below:
 
-> **Note:** Arjun uses `nano` as the default editor for the prompt but you can change it by tweaking `/core/prompt.py`.
+- [Scanning a single URL](https://github.com/s0md3v/Arjun/wiki/Usage#scanning-a-single-url)
+- [Scanning multiple URLs](https://github.com/s0md3v/Arjun/wiki/Usage#scanning-multiple-urls)
+- [Choosing number of threads](https://github.com/s0md3v/Arjun/wiki/Usage#multi-threading)
+- [Delay between requests](https://github.com/s0md3v/Arjun/wiki/Usage#delay-between-requests)
+- [Including presistent data](https://github.com/s0md3v/Arjun/wiki/Usage#including-persistent-data)
+- [Saving output to a file](https://github.com/s0md3v/Arjun/wiki/Usage#saving-output-to-a-file)
+- [Adding custom HTTP headers](https://github.com/s0md3v/Arjun/wiki/Usage#adding-http-headers)
 
 ##### Credits
 The parameter names are taken from [@SecLists](https://github.com/danielmiessler/SecLists).