Skip to content

Commit 3b00c58

Browse files
committed
Update docs and add usage images
README.md now includes example images for analysis, Web UI, and TUI usage.
1 parent 09b1ffb commit 3b00c58

3 files changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,15 @@ patternanalyzer analyze test.bin --out report.json
6262
Use a specific configuration profile for a focused analysis (e.g., cryptographic tests).
6363

6464
```bash
65-
patternanalyzer analyze encrypted.bin --profile crypto --out crypto_report.json```
65+
patternanalyzer analyze encrypted.bin --profile crypto --out crypto_report.json
66+
```
67+
68+
Generate an HTML report from the analysis results.
69+
70+
```bash
71+
patternanalyzer analyze test.bin --profile crypto --out crypto_report.json --html-report crypto_report.html
72+
```
73+
![image](https://cdn.goygoyengine.com/images/1761659991392-b0e66ddbb38349f5.jpg)
6674

6775
**Discovery Mode**
6876

@@ -76,20 +84,19 @@ The output file `discover_report.json` will contain a list of potential transfor
7684
### User Interfaces (Web & Terminal)
7785

7886
**Web UI (Streamlit)**
79-
8087
Launch an interactive web interface to upload files and visualize results.
81-
8288
```bash
8389
patternanalyzer serve-ui
8490
```
85-
91+
![webui](https://cdn.goygoyengine.com/images/1761659425529-a095c6d0a2b9a37b.jpg)
8692
**Terminal UI (TUI)**
8793

8894
Start a terminal-based interface for analysis directly in your console.
8995

9096
```bash
9197
patternanalyzer tui
9298
```
99+
![tui](https://cdn.goygoyengine.com/images/1761659533556-75e7668833632c7a.jpg)
93100

94101
### Python API
95102

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ First, clone the repository and set up a Python virtual environment.
1313

1414
```bash
1515
# Clone the repository
16-
git clone https://github.com/your-username/pattern-analyzer.git
16+
git clone https://github.com/edgetype/pattern-analyzer.git
1717
cd pattern-analyzer
1818

1919
# Create and activate a virtual environment

test.bin

-137 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)