Skip to content

Commit 5ec3075

Browse files
S1M0N38claude
andcommitted
docs: update README with LLM bot usage and setup
Add comprehensive documentation for LLM bot setup, configuration, and usage with LiteLLM proxy integration. Co-Authored-By: Claude <noreply@anthropic.com>
1 parent ca1c85c commit 5ec3075

1 file changed

Lines changed: 13 additions & 39 deletions

File tree

README.md

Lines changed: 13 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,12 @@
1212

1313
Add your project overview here.
1414

15-
## Features
16-
17-
**Development Tools**
18-
- **uv** – Lightning-fast Python package management
19-
- **Ruff** – Blazing fast Python linter and formatter
20-
- **Pyright** – Static type checker for Python
21-
- **pytest** – Comprehensive testing framework
22-
23-
**Automation**
24-
- **GitHub Actions** – Automated CI/CD pipeline
25-
- **Release Please** – Automated semantic versioning and releases
26-
- **PyPI Publishing** – Trusted publishing to PyPI
27-
2815
## Quick Start
2916

3017
### Prerequisites
3118

32-
- Python 3.11+
3319
- [uv](https://docs.astral.sh/uv/) package manager
20+
- Balatro instance with [BalatroBot](https://github.com/S1M0N38/balatrobot) running.
3421

3522
### Setup
3623

@@ -42,36 +29,25 @@ cd balatrollm
4229
# Create and activate environment
4330
uv sync --all-extras
4431

32+
# Configure environment
33+
cp .envrc.example .envrc
34+
4535
# Activate environment
46-
source .venv/bin/activate
36+
source .envrc
4737
```
4838

49-
### Development Commands
50-
51-
```bash
52-
# Run tests
53-
pytest
54-
55-
# Lint and format code
56-
ruff check
57-
ruff format
39+
### Usage
5840

59-
# Type check
60-
pyright
41+
1. Start the LiteLLM proxy (in a separate terminal)
6142

62-
# Run the application
63-
python -m balatrollm
43+
```bash
44+
litellm --config config/litellm.yaml
6445
```
6546

66-
## Project Structure
47+
2. Run the application
6748

68-
```
69-
balatrollm/
70-
├── src/balatrollm/ # Main package source
71-
├── tests/ # Test suite
72-
├── .github/workflows/ # CI/CD automation
73-
├── pyproject.toml # Project configuration
74-
└── README.md # This file
49+
```bash
50+
balatrollm
7551
```
7652

7753
## Contributing
@@ -91,8 +67,6 @@ This project is licensed under the MIT License – see the [LICENSE](LICENSE) fi
9167

9268
<div align="center">
9369

94-
**Ready to build something amazing?**
95-
9670
[Get Started](#quick-start)[Contribute](CONTRIBUTING.md)[Report Issues](https://github.com/S1M0N38/balatrollm/issues)
9771

98-
</div>
72+
</div>

0 commit comments

Comments
 (0)