Skip to content

Commit d9859f4

Browse files
authored
Update README.md
1 parent d518fea commit d9859f4

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
[![MIT License](https://img.shields.io/github/license/HenryLok0/CodeState?style=flat-square)](LICENSE)
77
[![Stars](https://img.shields.io/github/stars/HenryLok0/CodeState?style=flat-square)](https://github.com/HenryLok0/CodeState/stargazers)
88

9-
A CLI tool that analyzes your local codebase and generates detailed statistics, such as lines of code per file type, function complexity, comment density, and more. It visualizes the data as ASCII charts or exports to JSON, HTML, or Markdown for further use. This tool is designed for developers who want quick insights into their project's structure without relying on external services.
9+
Instant codebase insights in your terminal — fast, local, zero telemetry.
10+
11+
CodeState analyzes your repository and generates detailed statistics like lines of code by extension, complexity, comment density, hotspots, contributors, and more. It renders ASCII charts in the terminal and can export JSON/HTML/Markdown for reports.
1012

1113
## Installation
1214

@@ -158,6 +160,28 @@ codestate --multi src tests
158160
codestate --list-extensions
159161
```
160162

163+
## Comparison
164+
165+
| Tool | Quick ASCII visuals | Duplicate code | Git hotspots/churn | Contributors stats | Exports (HTML/CSV/Excel) | Caching |
166+
| --- | --- | --- | --- | --- | --- | --- |
167+
| CodeState | Yes (pie/heatmap/bar) | Yes | Yes | Yes | Yes | Yes |
168+
| cloc | No | No | No | No | Limited | No |
169+
| scc | Limited | No | No | No | Limited | No |
170+
| radon | Complexity only | No | No | No | No | No |
171+
172+
## Why CodeState?
173+
174+
- Beyond LOC: detect duplicates, complexity hotspots, refactor candidates, naming, dead code.
175+
- Developer-facing: ASCII charts (pie/heatmap/bar) directly in terminal — great for quick reviews.
176+
- History-aware: hotspots/churn from git to guide refactoring.
177+
- Team insights: contributors and blame stats per file.
178+
- Fast on repeats: built-in caching for large repos.
179+
Flexible exports: HTML/Markdown/JSON/CSV/Excel for reports and CI artifacts.
180+
181+
## Star History
182+
183+
[![Star History Chart](https://api.star-history.com/svg?repos=HenryLok0/CodeState&type=Date)](https://star-history.com/#HenryLok0/CodeState&Date)
184+
161185
## Contributing
162186

163187
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
@@ -174,4 +198,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
174198

175199
If you have questions or need help, please open an issue on GitHub.
176200

177-
Thank you to all contributors and the open-source community for your support.
201+
Thank you to all contributors and the open-source community for your support.

0 commit comments

Comments
 (0)