Skip to content

Commit 7a3d71f

Browse files
committed
chore: update docs
1 parent 7ea026e commit 7a3d71f

5 files changed

Lines changed: 5 additions & 954 deletions

File tree

README.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
A fast code analysis tool for remote repositories with multi-platform support.
1212

13+
![Banner](docs/banner.jpg)
14+
1315
## Features
1416

1517
- **Asynchronous Repository Processing**: Non-blocking HTTP client with async streaming request processing for efficient remote repository fetching and decompression, optimized for **low memory usage** and **serverless environments** (always `<32MiB` runtime memory usage for large files)
@@ -157,35 +159,7 @@ Analysis completed in 123.76s
157159
Lex 10 2,996 2,277 347 372 0.0%
158160
AWK 12 2,611 1,777 487 347 0.0%
159161
C++ 7 2,267 1,932 0 335 0.0%
160-
Forge Config 15 1,352 1,065 0 287 0.0%
161-
Bazel 78 1,303 1,097 21 185 0.0%
162-
Jinja2 141 1,107 902 137 68 0.0%
163-
Unreal Script 5 672 574 0 98 0.0%
164-
ASN.1 15 656 528 0 128 0.0%
165-
Markdown 3 578 436 0 142 0.0%
166-
LD Script 13 551 466 0 85 0.0%
167-
Autoconf 6 449 387 29 33 0.0%
168-
Gherkin (Cucumber) 1 330 293 0 37 0.0%
169-
CSS 3 295 241 0 54 0.0%
170-
SWIG 1 252 181 0 71 0.0%
171-
TeX 1 234 228 0 6 0.0%
172-
Alex 2 222 180 0 42 0.0%
173-
XSL 10 200 122 52 26 0.0%
174-
RPM Specfile 1 174 152 0 22 0.0%
175-
HEX 2 173 173 0 0 0.0%
176-
Module-Definition 2 157 137 0 20 0.0%
177-
Snakemake 4 143 114 15 14 0.0%
178-
Pacman's makepkg 1 131 102 0 29 0.0%
179-
C++ Header 2 125 106 0 19 0.0%
180-
Objective-C 1 89 72 0 17 0.0%
181-
TOML 3 47 40 0 7 0.0%
182-
Vim Script 1 42 39 0 3 0.0%
183-
HTML 2 33 30 0 3 0.0%
184-
Automake 3 31 23 3 5 0.0%
185-
Ruby 1 29 25 0 4 0.0%
186-
Apache Velocity 1 15 15 0 0 0.0%
187-
INI 2 13 11 0 2 0.0%
188-
Bitbake 3 13 4 6 3 0.0%
162+
...
189163
================================================================================
190164
Total 89,639 40,876,027 32,848,710 2,877,885 5,149,432 100.0%
191165
```
@@ -238,7 +212,7 @@ OPTIONS:
238212

239213
## Contributing
240214

241-
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
215+
We welcome contributions! Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for guidelines.
242216

243217
### Development Setup
244218

@@ -269,7 +243,7 @@ cargo clippy --all-targets --all-features
269243
> [!TIP]
270244
> The Free Tier of Cloudflare Workers has a **20s request timeout limit** (wall time). Analysis of large repositories may fail due to this limitation. Consider upgrading to Cloudflare Workers Pro or using alternative deployment methods for processing large repositories.
271245
272-
For detailed deployment instructions and API documentation, see [DEPLOYMENT.md](DEPLOYMENT.md).
246+
For detailed deployment instructions and API documentation, see [DEPLOYMENT.md](docs/DEPLOYMENT.md).
273247

274248
## Usage Environments
275249

File renamed without changes.
File renamed without changes.

docs/banner.jpg

591 KB
Loading

0 commit comments

Comments
 (0)