Update README.md

Sanjai kumar · web-flow · commit f91da604f90f · 2023-12-09T13:43:29.000+05:30
diff --git a/README.md b/README.md
@@ -1,122 +1,194 @@
-# Subprober - PyThon based Probing tool for urls and subdomains.
+# Subprober v1.0.3 - Fast Probing Tool for Penetration Testing
 
-Subprober is a Python tool designed to efficiently probe and get essentials user desired data for list of urls and subdomains subdomains. It uses concurrent features to speed up the process
-and users can define their preferred concurrency level to optimize the scanning speed and It probeds and get details for users that they desired by switching the flags for details.Support 
-this contribution by giving a ⭐ and show your ♥️!
+![GitHub last commit](https://img.shields.io/github/last-commit/sanjai-AK47/Subprober) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/sanjai-AK47/Subprober) [![GitHub license](https://img.shields.io/github/license/sanjai-AK47/Subprober)](https://github.com/sanjai-AK47/Subprober/blob/main/LICENSE) [![LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue)](https://www.linkedin.com/in/d-sanjai-kumar-109a7227b/)
 
-# Features
+### Overview
 
-- Defaultly get the status codes for urls and subdomains
-- Get server name of the web page
-- Get title of the  web page 
-- Get word count of web page
-- Get application type of web page
-- Concurrency built-in and user defined values for probing
-- Match and Exclude for user desired status codes
-- Verbose and concise flags for user desired console system for output
-- Update system integrated for future updates
-- Supports stdin and stdout to easily pipe to give input for Subprober
-- Good colourised CLI interface consolings
-- User defined or auto save are integrated
-- Asynchronous probing with concurrency integrated
-- Probes for http and https protocols for urls and subdomains
-- Easy installation through pip
+Subprober v1.0.3 is a powerful and efficient tool designed for penetration testers and security professionals. This release introduces several enhancements, bug fixes, and new features to elevate your subdomain probing experience. Subprober facilitates fast and reliable information extraction, making it an invaluable asset for penetration testing workflows.
 
-# Requirements
+### Features in V1.0.3:
+- Subprober logical bug has resolved .
+- Subprober accuracy in results are improved .
+- Now Subprober shows the progress of it task .
+- Concurrency has been improved .
+- Support only stdin .
 
-- Subprober requires python 3.11.+
+### Installation
 
-# Installation :
+##### Method 1:
 
-## Method 1:
+```bash
+pip install subprober
+```
 
-1. Clone the repository:
+#### Method 2:
 
 ```bash
-   pip install subprober
-   subprober --help
+git clone https://github.com/sanjai-AK47/SubProber.git
+cd Subprober
+pip install .
 ```
-If the pip Method installation not worked properly you can also install it thorugh Method 2 below.
 
-## Method 2:
+### Help for Subprober:
+
+```yaml
+subprober -h
+ 
+
+   _____       __    ____             __             
+  / ___/__  __/ /_  / __ \_________  / /_  ___  _____
+  \__ \/ / / / __ \/ /_/ / ___/ __ \/ __ \/ _ \/ ___/
+ ___/ / /_/ / /_/ / ____/ /  / /_/ / /_/ /  __/ /    
+/____/\__,_/_.___/_/   /_/   \____/_.___/\___/_/     
+                                                         
+                
+                
+                    Author : D.Sanjai Kumar @CyberRevoltSecurities
+
+                                                                         
+                                                  
+
+          
+Subprober - A Fast Probing Tool for Penetration testing
+
+[Description] :
+
+    Subprober is a high-performance tool designed for probing and  extract vital information efficiently.
+
+[Flags]:
+
+    -f, --filename            Specify the filename containing a list of subdomains for targeted probing. 
+                              This flag is used to find and analyze status codes and other pertinent details.
+                      
+    -h, --help                Show this help message for you and exit!
+    
+    -u, --url                 Specify a target URL for direct probing. This flag allows for the extraction of 
+                              status codes and other valuable information.
+                      
+    -sp. --show-progress      Enable show prgress mode which will show the progress of the Subprober with progress bar like this ( example: |████████████████████████████████████████| 4000/4000 [100%] in 12.4s (3.23/s) ).
+
+
+    -o, --output              Define the output filename to store the results of the probing operation.
+
+    -c, --concurrency         Set the concurrency level for multiple processes. Default is 10.
+
+    -tl, --title              Retrieve and display the title of subdomains.
+
+    -to, --timeout            Set a custom timeout value for sending requests.
+
+    -sv, --server             Identify and display the server information associated with subdomains.
+
+    -wc, --word-count         Retrieve and display the content length of subdomains.
+
+    -apt, --application-type  Determine and display the application type of subdomains.
+
+    -ex, --exclude            Exclude specific response status code(s) from the analysis.
+
+    -mc, --match              Specify specific response status code(s) to include in the analysis.
+
+    -suo, --save-urls-only    Save only URLs for particular status codes, excluding other information.
+
+    -s, --silent              Enable silent mode to suppress the display of Subprober banner and version information.
+
+    -v, --verbose             Enable verbose mode to display detailed results on the console.
+
+    -cs, --concise            Enable concise mode to display only timeout or request failure URLs or subdomains.
+
+    -exs, --excluded-save     Save the results of excluded status codes when the --exclude switch is enabled.
+
+    -ums, --unmatch-save      Save the results of unmatched status codes when the --match switch is enabled.
+
+    -up, --update             Update Subprober to the latest version through pip.
+
+[INFO]:
+
+    subprober -f subdomains.txt -o output.txt -tl -wc -sv -v -apt -wc -ex 404 500 -suo 200 -v -o output.txt -c 
+    
+    subprober -u https://example.com -c 20 -to 8  -tl -sv  -wc -apt -ex 404 500 -suo 200 -v -o output.txt
+    
+    cat subdomains.txt | subprober -c 20 -to 8 -tl -sv -wc -apt -ex 404 500 -suo 200 -v -o output.txt
 
-```bash
-   git clone https://github.com/sanjai-AK47/Subprober.git
-   cd Subprober
-   pip install .
-   subprober --help
 ```
 
-## Usage
+### Usage Examples
 
-Run Subprober from the command line with the following options:
+#### Basic Usage
 
 ```bash
-Usage: subprober [OPTIONS]
-
-Options:
-  -h, --help            show this help message and exit
-  -f FILENAME, --filename FILENAME
-                        [INFO]: A filename that contains list of subdomains to probe and find status codes and other informations
-  -u URL, --url URL     [INFO]: A url to probe to find status codes and other informations
-  -o OUTPUT, --output OUTPUT
-                        [INFO]: Filename to write the output
-  -c CONCURRENCY, --concurrency CONCURRENCY
-                        [INFO]: Concurrency level for Multiple process
-  -tl, --title          [INFO]: Get Title of subdomains
-  -sv, --server         [INFO]: Get server of subdomains
-  -wc, --word-count     [INFO]: Get content length of subdomains
-  -apt, --application-type
-                        [INFO]: Get application type of subdomains
-  -ex [EXCLUDE ...], --exclude [EXCLUDE ...]
-                        [INFO]: Exclude the particular response status code
-  -mc [MATCH ...], --match [MATCH ...]
-                        [INFO]: the particular response status code
-  -suo [SAVE_URLS_ONLY ...], --save-urls-only [SAVE_URLS_ONLY ...]
-                        [INFO]: Save only urls for particular status codes instead of other informations
-  -s, --silent          [INFO]: Switching silent will not print Subprober banner and version
-  -v, --verbose         [INFO]: Switching Verbose to console the results
-  -cs, --concise        [INFO]: Switching Consice to console time out or request failured urls or subdomains
-  -exs, --excluded-save
-                        [INFO]: Switching Exluded save the excluded status codes results when --exclude switch is enabled
-  -ums, --unmatch-save  [INFO]: Switching Unmatch save the Unmatched status codes results when --match switch is enabled
-  -up, --update         [INFO]: Update the Subprober to latest version through pip
-                   Show this message and exit.
+subprober -f subdomains.txt -o output.txt -tl -wc -sv -v -apt -wc -ex 404 500 -suo 200 -v -o output.txt -c
 ```
 
-- `-f` or `--filename`: Specify the file containing the list of subdomains to check.
-- `-c` or `--concurrency`: Set the concurrency level. Higher values increase scanning speed, but use it cautiously to avoid overloading the target server.
-- `-v` or `--verbose`: Print detailed output while scanning.
-- `c` or `--concise` : Print the timeout errored urls and subdomains.
-- `-s` or `--silent` : Silent swtich doesn't console the banner and version.
-- `tl` or `--title`  : Get the Title of the web page that probes.
-- `-sv` or `--server` : Get the Server name of the web page that probes.
-- `wc` or `--word-coubt` : Get the word count of the web page that probes.
-- `apt` or `--application-type`: Get the application type of the web page that probes.
-- `mc` or `--match` : The Match flag will help to print and save only user desired status coded results.
-- `ums` or `ums` : This flag is used when user uses `-mc` flag to print particular results but when user when users want also save the unmatched urls this flag can be used.
-- `-ex` or `--exclude` : Exclude and not console and save the output.
-- `-exs` or `--excluded-save` : Swtiching these flags will help to save excluded satus code results when user desired not to print the excluded url but to save the results.
-- `-o` or `--output`: Save the output to a file.
-- `-up` or `--update`: Update the Subprober to the latest version.
-
-## Run Subprber through flags:
+### Direct URL Probing
 
 ```bash
-   subprober -f subdomains.txt -c 20 -o results.txt --verbose --title --server --application-type --word-count -mc 200 301 302
+subprober -u https://example.com -c 20 -to 8 -tl -sv -wc -apt -ex 404 500 -suo 200 -v -o output.txt
 ```
 
-###### [INFO]: Subprober prefered concurrency rate is 20 which very efficient to run and get accurate results also avoids rate limiting
+### Piping Subdomains
 
-## Run Subprober thorugh pipe :
 ```bash
-   subprober --verbose -c 20 -o results.txt --verbose --title --server --application-type --word-count -mc 200 301 302
+cat subdomains.txt | subprober -c 20 -to 8 -tl -sv -wc -apt -ex 404 500 -suo 200 -v -o output.txt
 ```
 
-# Sample Image of Subprober:
+## Flags and Options
+
+### Basic Flags
+
+- **-f, --filename**: Specify the filename containing a list of subdomains for targeted probing.
+
+- **-h, --help**: Show the help message and exit.
+
+- **-u, --url**: Specify a target URL for direct probing.
+
+- **-sp, --show-progress**: Enable show progress mode to display a progress bar.
+
+- **-o, --output**: Define the output filename to store the results.
+
+### Advanced Flags
+
+- **-c, --concurrency**: Set the concurrency level for multiple processes. Default is 10.
+
+- **-tl, --title**: Retrieve and display the title of subdomains.
+
+- **-to, --timeout**: Set a custom timeout value for sending requests.
+
+- **-sv, --server**: Identify and display the server information associated with subdomains.
+
+- **-wc, --word-count**: Retrieve and display the content length of subdomains.
+
+- **-apt, --application-type**: Determine and display the application type of subdomains.
+
+- **-ex, --exclude**: Exclude specific response status code(s) from the analysis.
+
+- **-mc, --match**: Specify specific response status code(s) to include in the analysis.
+
+- **-suo, --save-urls-only**: Save only URLs for particular status codes, excluding other information.
+
+- **-s, --silent**: Enable silent mode to suppress the display of Subprober banner and version information.
+
+- **-v, --verbose**: Enable verbose mode to display detailed results on the console.
+
+- **-cs, --concise**: Enable concise mode to display only timeout or request failure URLs or subdomains.
+
+- **-exs, --excluded-save**: Save the results of excluded status codes when the --exclude switch is enabled.
+
+- **-ums, --unmatch-save**: Save the results of unmatched status codes when the --match switch is enabled.
+
+- **-up, --update**: Update Subprober to the latest version through pip.
+
+### License
+
+Subprober is open-source software licensed under the MIT License. See the [LICENSE](https://github.com/sanjai-AK47/Subprober/blob/main/LICENSE) file for details.
+
+### Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to help improve Subprober.
+
+
+### Sample Usage of Subprober:
 ![Screenshot from 2023-11-12 19-00-28](https://github.com/sanjai-AK47/SubProber/assets/119435129/2403d849-c91f-4d09-92f5-8314ae1a18ef)
 
-## Information:
+### Information:
 This tool is developed by [D.Sanjai Kumar](https://www.linkedin.com/in/d-sanjai-kumar-109a7227b/) for support the open source community for CyberSecurity and Ethical Hacking and
 The Subprober is built for reconnaissance and ethical hacking purposes and developer is not responsible for any unethical purposes so
 please use the Subprober with responsible and Ethically . Happy Hacking Hackers you can support my contribution by giving a ⭐ to the Subprober which motivate me to develop more like this ♥️.
