From f720d4e9fc26294c8ca4253f87ae4bd508ffbc4a Mon Sep 17 00:00:00 2001
From: Coffee & Security <104401469+coffeeandsecurity@users.noreply.github.com>
Date: Tue, 12 Nov 2024 00:12:31 +0530
Subject: [PATCH] Updated README

Updated README
---
 README.md | 60 ++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 37 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index a44ec0c..f442128 100644
--- a/README.md
+++ b/README.md
@@ -87,44 +87,58 @@ Once the above step successfully installs all the required libraries, refer to t
 
 ## Tool Usage
 
-$ python3 dakshscra.py -h		// To view avaialble options and arguments
+$ python3 dakshscra.py -h		// To view available options and arguments
 
 	usage: dakshscra.py [-h] [-r RULE_FILE] [-f FILE_TYPES] [-v] [-t TARGET_DIR] [-l {R,RF}] [-recon] [-estimate]
 
 	options:
-	-h, --help            show this help message and exit
-	-r RULE_FILE          Specify platform specific rule name
-	-f FILE_TYPES         Specify file types to scan
-	-v                    Specify verbosity level {'-v', '-vv', '-vvv'}
-	-t TARGET_DIR         Specify target directory path
-	-l {R,RF}, --list {R,RF}
-							List rules [R] OR rules and filetypes [RF]
-	-recon                Detects platform, framework and programming language used
-	-estimate             Estimate efforts required for code review
+	-h, --help Show this help message and exit
+	-r RULE_FILE Specify platform-specific rule name or 'auto' for auto-detection of platforms
+	-f FILE_TYPES Specify file types to scan
+	-v Specify verbosity level {'-v', '-vv', '-vvv'}
+	-t TARGET_DIR Specify target directory path
+	-l {R,RF}, --list {R,RF} List rules [R] OR rules and filetypes [RF]
+	-recon Detects platform, framework, and programming language used
+	-estimate Estimate efforts required for code review
 
 ### Example Usage
 $ python3 dakshscra.py		// To view tool usage along with examples
 
 	Examples:
 	# '-f' is optional. If not specified, it will default to the corresponding filetypes of the selected rule.
-	dakshsca.py -r php -t /source_dir_path
+	dakshscra.py -r php -t /source_dir_path
 
-	# To override default settings, other filetypes can be specified with '-f' option.
-	dakshsca.py -r php -f dotnet -t /path_to_source_dir
-	dakshsca.py -r php -f custom -t /path_to_source_dir
+	# Specify platforms with '-r' (single or multiple) for platform-specific rules:
+	- Single platform: dakshscra.py -r php -t /source_dir_path
+	- Multiple platforms: dakshscra.py -r php,java,cpp -t /source_dir_path
+	- Auto-detect Platforms: dakshscra.py -r auto -t /source_dir_path
 
-	# Perform reconnaissance and rule based scanning if '-recon' used with '-r' option.
-	dakshsca.py  -recon -r php -t /path_to_source_dir
+	# To override default settings, other filetypes can be specified with the '-f' option:
+	dakshscra.py -r php -f dotnet -t /path_to_source_dir
+	dakshscra.py -r php -f custom -t /path_to_source_dir
 
-	# Perform only reconnaissance if '-recon' used without the '-r' option.
-	dakshsca.py  -recon -t /path_to_source_dir
-
-	# Verbosity: '-v' is default, '-vvv' will display all rules check within each rule category.
-	dakshsca.py -r php -vv -t /path_to_source_dir
+	# Perform reconnaissance and rule-based scanning if '-recon' used with '-r' option:
+	dakshscra.py  -recon -r php -t /path_to_source_dir
 
+	# Perform only reconnaissance if '-recon' used without the '-r' option:
+	dakshscra.py  -recon -t /path_to_source_dir
 
-	Supported RULE_FILE: 	dotnet, java, php, python, javascript
-	Supported FILE_TYPES:	dotnet, java, php, python, javascript, custom, allfiles
+	# Verbosity: '-v' is default, '-vvv' will display all rules check within each rule category.
+	dakshscra.py -r php -vv -t /path_to_source_dir
+
+### List of all available rules
+$ python3 dakshscra.py -l R 		# View list of supported rules
+        dotnet
+        php
+        java
+        javascript
+        kotlin
+        python
+        go
+        c
+        cpp
+        android (beta - limited checks)
+        common
 
 
 ## Reports