Update-docs-and-readme

README.md

@@ -19,18 +19,21 @@
 </p>
 
 <p align="center">
-  <a href="#key-features">Key Features</a> •
-  <a href="#available-support-scope">Available Support Scope</a> •
   <a href="#installation">Installation</a> •
+  <a href="https://owasp-noir.github.io/noir/">Documentation</a> •
+  <a href="#available-support-scope">Available Support Scope</a> •
   <a href="#usage">Usage</a> •
   <a href="#contributing">Contributing</a>
 </p>
 
 ## Key Features
-- Automatically identify language and framework from source code.
-- Find API endpoints and web pages through code analysis.
-- Load results quickly through interactions with proxy tools such as ZAP, Burpsuite, Caido and More Proxy tools.
-- That provides structured data such as JSON and YAML for identified Attack Surfaces to enable seamless interaction with other tools. Also provides command line samples to easily integrate and collaborate with other tools, such as curls or httpie.
+
+- Identify API endpoints and parameters from source code.
+- Support various source code languages and frameworks.
+- Provide analysts with technical information and security issues identified during source code analysis.
+- Friendly pipeline & DevOps integration, offering multiple output formats (JSON, YAML, OAS spec) and compatibility with tools like curl and httpie.
+- Friendly Offensive Security Tools integration, allowing usage with tools such as ZAP and Caido, Burpsuite.
+- Generate elegant and clear output results.
 
 ## Available Support Scope
 
@@ -135,64 +138,11 @@ docker pull ghcr.io/owasp-noir/noir:main
 ```
 
 ## Usage
+
 ```bash
 noir -h 
 ```
 
-```
-USAGE: noir <flags>
-
-FLAGS:
-  BASE:
-    -b PATH, --base-path ./app       (Required) Set base path
-    -u URL, --url http://..          Set base url for endpoints
-
-  OUTPUT:
-    -f FORMAT, --format json         Set output format
-                                       * plain yaml json jsonl markdown-table
-                                       * curl httpie oas2 oas3
-                                       * only-url only-param only-header only-cookie
-    -o PATH, --output out.txt        Write result to file
-    --set-pvalue VALUE               Specifies the value of the identified parameter
-    --include-path                   Include file path in the plain result
-    --no-color                       Disable color output
-    --no-log                         Displaying only the results
-
-  TAGGER:
-    -T, --use-all-taggers            Activates all taggers for full analysis coverage
-    --use-taggers VALUES             Activates specific taggers (e.g., --use-taggers hunt,oauth)
-    --list-taggers                   Lists all available taggers
-
-  DELIVER:
-    --send-req                       Send results to a web request
-    --send-proxy http://proxy..      Send results to a web request via an HTTP proxy
-    --send-es http://es..            Send results to Elasticsearch
-    --with-headers X-Header:Value    Add custom headers to be included in the delivery
-    --use-matchers string            Send URLs that match specific conditions to the Deliver
-    --use-filters string             Exclude URLs that match specified conditions and send the rest to Deliver
-
-  DIFF:
-    --diff-path ./app2               Specify the path to the old version of the source code for comparison
-
-  TECHNOLOGIES:
-    -t TECHS, --techs rails,php      Specify the technologies to use
-    --exclude-techs rails,php        Specify the technologies to be excluded
-    --list-techs                     Show all technologies
-
-  CONFIG:
-    --config-file ./config.yaml      Specify the path to a configuration file in YAML format
-    --concurrency 100                Set concurrency
-    --generate-completion zsh        Generate Zsh/Bash completion script
-
-  DEBUG:
-    -d, --debug                      Show debug messages
-    -v, --version                    Show version
-    --build-info                     Show version and Build info
-
-  OTHERS:
-    -h, --help                       Show help
-```
-
 Example
 ```bash
 noir -b . -u https://testapp.internal.domains -T
@@ -242,6 +192,8 @@ noir -b . -u https://testapp.internal.domains -f json -T
   }
 ```
 
+For more details, please visit our [documentation](https://owasp-noir.github.io/noir/) page.
+
 ## Contributing
 Noir is open-source project and made it with ❤️ 
 if you want contribute this project, please see [CONTRIBUTING.md](./CONTRIBUTING.md) and Pull-Request with cool your contents.

docs/_get_started/basic.md

@@ -26,4 +26,60 @@ noir -b <BASE_PATH>
 
 The output will display endpoints (such as paths, methods, parameters, headers, etc.), and you can specify the output format using flags like `-f`.
 
-![](../../images/get_started/basic.png)
+![](../../images/get_started/basic.png)
+
+## Usage
+
+```
+USAGE: noir <flags>
+
+FLAGS:
+  BASE:
+    -b PATH, --base-path ./app       (Required) Set base path
+    -u URL, --url http://..          Set base url for endpoints
+
+  OUTPUT:
+    -f FORMAT, --format json         Set output format
+                                       * plain yaml json jsonl markdown-table
+                                       * curl httpie oas2 oas3
+                                       * only-url only-param only-header only-cookie
+    -o PATH, --output out.txt        Write result to file
+    --set-pvalue VALUE               Specifies the value of the identified parameter
+    --include-path                   Include file path in the plain result
+    --no-color                       Disable color output
+    --no-log                         Displaying only the results
+
+  TAGGER:
+    -T, --use-all-taggers            Activates all taggers for full analysis coverage
+    --use-taggers VALUES             Activates specific taggers (e.g., --use-taggers hunt,oauth)
+    --list-taggers                   Lists all available taggers
+
+  DELIVER:
+    --send-req                       Send results to a web request
+    --send-proxy http://proxy..      Send results to a web request via an HTTP proxy
+    --send-es http://es..            Send results to Elasticsearch
+    --with-headers X-Header:Value    Add custom headers to be included in the delivery
+    --use-matchers string            Send URLs that match specific conditions to the Deliver
+    --use-filters string             Exclude URLs that match specified conditions and send the rest to Deliver
+
+  DIFF:
+    --diff-path ./app2               Specify the path to the old version of the source code for comparison
+
+  TECHNOLOGIES:
+    -t TECHS, --techs rails,php      Specify the technologies to use
+    --exclude-techs rails,php        Specify the technologies to be excluded
+    --list-techs                     Show all technologies
+
+  CONFIG:
+    --config-file ./config.yaml      Specify the path to a configuration file in YAML format
+    --concurrency 100                Set concurrency
+    --generate-completion zsh        Generate Zsh/Bash completion script
+
+  DEBUG:
+    -d, --debug                      Show debug messages
+    -v, --version                    Show version
+    --build-info                     Show version and Build info
+
+  OTHERS:
+    -h, --help                       Show help
+```