Skip to content

Commit b2fce11

Browse files
committed
Add README.md
0 parents  commit b2fce11

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# roast-my-code
2+
3+
![Python](https://img.shields.io/badge/python-3.11%2B-blue)
4+
![License](https://img.shields.io/badge/license-MIT-green)
5+
6+
The AI that roasts your codebase so your teammates don't have to.
7+
8+
## Install
9+
10+
```bash
11+
pip install roast-my-code
12+
```
13+
14+
## Usage
15+
16+
```bash
17+
roast ./my-project
18+
roast https://github.com/user/repo
19+
roast ./my-project --no-llm --output report.html
20+
```
21+
22+
## Demo
23+
24+
[demo.gif]
25+
26+
## Contributing
27+
28+
Contributions are welcome. Open an issue for bugs/ideas, then submit a PR with tests for behavior changes.

0 commit comments

Comments
 (0)