Skip to content

Commit bd07e94

Browse files
docs: rewrite README to present CodeState as a native Rust tool
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent f222b54 commit bd07e94

1 file changed

Lines changed: 2 additions & 20 deletions

File tree

README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[MIT License](LICENSE)
44
[Stars](https://github.com/HenryLok0/CodeState/stargazers)
55

6-
**Written in Rust. Blazingly fast.**
6+
**Blazingly fast.**
77

8-
Instant codebase insights in your terminal — fast, local, zero telemetry. CodeState 2.0 has been completely rewritten in Rust to provide extreme performance on par with `tokei` and `scc`, while keeping its unique advanced features like Git Hotspot analysis and Code Health tracking.
8+
Instant codebase insights in your terminal — fast, local, zero telemetry. CodeState provides extreme performance while keeping its unique advanced features like Git Hotspot analysis and Code Health tracking.
99

1010
## Features
1111

@@ -216,23 +216,6 @@ codestate --multi src tests
216216
codestate --list-extensions
217217
```
218218

219-
## Comparison
220-
221-
222-
| Feature | CodeState | cloc | scc | tokei |
223-
| -------------------------------------- | --------- | --------------- | --------------- | --------------- |
224-
| Stats (files/lines/comments) | Yes | Yes | Yes | Yes |
225-
| ASCII charts / heatmap in terminal | Yes | No | No | No |
226-
| Report exports (HTML / Markdown / CSV) | Yes | Limited | Limited | Limited |
227-
| .gitignore awareness & caching | Yes | Manual excludes | Manual excludes | Manual excludes |
228-
| Hotspots / duplicates / naming checks | Yes | No | No | No |
229-
230-
231-
Notes:
232-
233-
- “Manual excludes” means the tool supports flags to ignore paths but doesn’t automatically read .gitignore or provide built-in caching like CodeState.
234-
- See Performance benchmarks below for speed guidance and how to reproduce measurements.
235-
236219
## Why CodeState?
237220

238221
- Instant understanding: go beyond LOC to highlight duplicates, complexity hotspots, refactor candidates, naming issues, and dead code — right in your terminal.
@@ -270,7 +253,6 @@ Thank you to all contributors and the open-source community for your support.
270253

271254
## Troubleshooting
272255

273-
- Command not found: try `python -m codestate.cli` instead of `codestate`.
274256
- Windows path/encoding quirks: run from a local folder (avoid syncing folders) and ensure UTF-8 console.
275257
- Very large repos: run once with `--cache`, then subsequent commands will be much faster.
276258

0 commit comments

Comments
 (0)