Skip to content

Commit 092ef5c

Browse files
committed
Update README.md
1 parent aa3ba06 commit 092ef5c

1 file changed

Lines changed: 26 additions & 10 deletions

File tree

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<p align="center">
88
<img src="https://img.shields.io/badge/version-1.0.0-0A66C2?style=for-the-badge" alt="Version">
99
<img src="https://img.shields.io/badge/ruby-%3E%3D%203.2-red?style=for-the-badge&logo=ruby&logoColor=white" alt="Ruby >= 3.2">
10-
<img src="https://img.shields.io/badge/tests-51%2F51%20passing-2E8B57?style=for-the-badge" alt="Tests Passing">
10+
<img src="https://img.shields.io/badge/tests-52%2F52%20passing-2E8B57?style=for-the-badge" alt="Tests Passing">
1111
<img src="https://img.shields.io/badge/verify-bundle%20exec%20rake%20passing-2E8B57?style=for-the-badge" alt="Rake Verify Passing"><br>
1212
<img src="https://img.shields.io/badge/status-stable-4C956C?style=for-the-badge" alt="Status Stable">
1313
<img src="https://img.shields.io/badge/license-Proprietary-8B0000?style=for-the-badge" alt="License"><br>
@@ -19,7 +19,20 @@ ASRFacet-Rb is a Ruby 3.2+ attack surface reconnaissance framework for authorize
1919

2020
Current framework version: `1.0.0`
2121

22-
## Documentation
22+
Project website: [https://voltsparx.github.io/ASRFacet-Rb/](https://voltsparx.github.io/ASRFacet-Rb/)
23+
24+
## Start Here
25+
26+
| Resource | Link | Purpose |
27+
| --- | --- | --- |
28+
| Website Docs | `https://voltsparx.github.io/ASRFacet-Rb/` | Multi-page guide for installation, workflow, modes, and reporting |
29+
| Getting Started | `docs/getting-started.md` | Local setup and first-run path |
30+
| Architecture | `docs/architecture.md` | Core execution model and module boundaries |
31+
| Web Session Guide | `docs/web-session.md` | Browser UI behavior and session workflow |
32+
| Lab Guide | `docs/lab.md` | Safe local validation before real authorized targets |
33+
| Reporting Guide | `docs/reporting.md` | Output formats, storage layout, and interpretation |
34+
35+
## 📚 Documentation
2336

2437
The full first-release documentation set lives in `docs/`.
2538

@@ -40,13 +53,13 @@ Execution ownership stays intentionally strict: the scheduler owns orchestration
4053
execution helpers run work, and engines do not create their own competing
4154
control loops.
4255

43-
The current README reflects the latest verified release-style test run on April 8, 2026: `bundle exec rake` completed successfully, including `51 examples, 0 failures`, CLI smoke checks, web-session smoke checks, local lab smoke checks, installer smoke checks, and a clean gem build.
56+
The current README reflects the latest verified release-style test run on April 8, 2026: `bundle exec rake` completed successfully, including `52 examples, 0 failures`, CLI smoke checks, web-session smoke checks, local lab smoke checks, installer smoke checks, website-installer smoke checks, and a clean gem build.
4457

45-
## Authorized Use
58+
## 🛡️ Authorized Use
4659

4760
Use ASRFacet-Rb only on systems you own or have explicit written permission to test. The framework is built to help operators stay inside scope through allow lists, exclusion lists, recon memory, and beginner-friendly explanations.
4861

49-
## What It Does
62+
## 🔎 What It Does
5063

5164
<table>
5265
<thead>
@@ -95,7 +108,9 @@ Use ASRFacet-Rb only on systems you own or have explicit written permission to t
95108
</tbody>
96109
</table>
97110

98-
## Installation
111+
## 🛠️ Installation
112+
113+
From source:
99114

100115
```bash
101116
bundle install
@@ -105,7 +120,7 @@ bundle exec ruby bin/asrfacet-rb about
105120
bundle exec ruby bin/asrfacet-rb --explain scope
106121
```
107122

108-
Cross-platform installers are also available in `install/`:
123+
Using cross-platform installers from `install/`:
109124

110125
```text
111126
install/windows.ps1 # install | test | uninstall | update
@@ -122,7 +137,7 @@ For local manual-page testing:
122137
MANPATH="$PWD/man:$MANPATH" man asrfacet-rb
123138
```
124139

125-
## Testing
140+
## Testing
126141

127142
Use the Rake-based verification flow for routine checks:
128143

@@ -133,6 +148,7 @@ bundle exec rake test:cli
133148
bundle exec rake test:web
134149
bundle exec rake test:lab
135150
bundle exec rake test:install
151+
bundle exec rake test:website_installers
136152
```
137153

138154
There is also a reusable script harness under `test/`:
@@ -141,7 +157,7 @@ There is also a reusable script harness under `test/`:
141157
ruby test/run_all.rb
142158
```
143159

144-
## Quick Start
160+
## 🚀 Quick Start
145161

146162
<table>
147163
<thead>
@@ -200,7 +216,7 @@ ruby test/run_all.rb
200216
</tbody>
201217
</table>
202218

203-
## Command Reference
219+
## 📖 Command Reference
204220

205221
<table>
206222
<thead>

0 commit comments

Comments
 (0)