docs: update readme

This commit is contained in:
DaisukeYoda
2025-10-04 15:57:06 +09:00
parent 2af4b37886
commit cac0f3d6f3

View File

@@ -5,20 +5,9 @@
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![CI](https://img.shields.io/badge/CI-Passing-brightgreen.svg)](https://github.com/ludo-technologies/pyscn/actions)
**pyscn is a code quality analyzer for Python vibe coders.**
## pyscn is a code quality analyzer for Python vibe coders.
Building with Cursor, Claude, or ChatGPT? pyscn performs structural analysis to keep your codebase maintainable:
- 🔍 **CFG-based dead code detection** Find unreachable code after exhaustive if-elif-else chains
- 📋 **Clone detection with APTED + LSH** Identify refactoring opportunities with tree edit distance
- 🔗 **Coupling metrics (CBO)** Track architecture quality and module dependencies
- 📊 **Cyclomatic complexity analysis** Spot functions that need breaking down
**100,000+ lines/sec** • Built with Go + tree-sitter
## Demo
https://github.com/user-attachments/assets/b7e9d72e-0845-4a1e-a6a0-e34e00ed8a39
Building with Cursor, Claude, or ChatGPT? pyscn performs structural analysis to keep your codebase maintainable.
## Quick Start
@@ -29,6 +18,20 @@ uvx pyscn analyze .
pipx run pyscn analyze .
```
## Demo
https://github.com/user-attachments/assets/b7e9d72e-0845-4a1e-a6a0-e34e00ed8a39
## Features
- 🔍 **CFG-based dead code detection** Find unreachable code after exhaustive if-elif-else chains
- 📋 **Clone detection with APTED + LSH** Identify refactoring opportunities with tree edit distance
- 🔗 **Coupling metrics (CBO)** Track architecture quality and module dependencies
- 📊 **Cyclomatic complexity analysis** Spot functions that need breaking down
**100,000+ lines/sec** • Built with Go + tree-sitter
## Common Commands
### `pyscn analyze`