Skip to content

Commit dda44b4

Browse files
committed
Document free Groq primary + NIM backup setup
1 parent aedfb14 commit dda44b4

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ The AI that roasts your codebase so your teammates don't have to.
1111
pip install roast-my-code
1212
```
1313

14+
## Free LLM Setup (Recommended)
15+
16+
Use Groq as primary (free tier), and NVIDIA NIM as backup.
17+
18+
```bash
19+
export GROQ_API_KEY="your-groq-key"
20+
export NVIDIA_NIM_API_KEY="your-nim-key"
21+
```
22+
23+
Default model choices in this project:
24+
- Primary: `llama-3.3-70b-versatile` (Groq)
25+
- Backup: `microsoft/phi-4-mini-instruct` (NIM)
26+
1427
## Usage
1528

1629
```bash
@@ -19,10 +32,17 @@ roast https://github.com/user/repo
1932
roast ./my-project --no-llm --output report.html
2033
```
2134

35+
Provider controls:
36+
37+
```bash
38+
roast ./my-project --provider groq --model llama-3.3-70b-versatile
39+
roast ./my-project --provider auto --backup-provider nim --backup-model microsoft/phi-4-mini-instruct
40+
```
41+
2242
## Demo
2343

2444
[demo.gif]
2545

2646
## Contributing
2747

28-
Contributions are welcome. Open an issue for bugs/ideas, then submit a PR with tests for behavior changes.
48+
Contributions are welcome. Open an issue for bugs/ideas, then submit a PR with tests for behavior changes.

0 commit comments

Comments
 (0)