Skip to content

Commit 1a457d6

Browse files
committed
readme
1 parent d49a11b commit 1a457d6

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# isn't that odd
22

3+
[![CI](https://github.com/LaunchPlatform/isnt_that_odd/actions/workflows/ci.yml/badge.svg)](https://github.com/LaunchPlatform/isnt_that_odd/actions/workflows/ci.yml)
4+
35
A Python library that determines if a given number is even or not by sending prompts to LLM APIs. Built with LiteLLM for universal LLM support and structured output for reliable responses.
46

57
**Proudly built by vibe coding 🚀**
@@ -15,14 +17,38 @@ A Python library that determines if a given number is even or not by sending pro
1517

1618
## Installation
1719

20+
### From PyPI with pip
21+
22+
```bash
23+
pip install isnt_that_odd
24+
```
25+
1826
### Using uv (Recommended)
1927

2028
```bash
2129
# Install uv if you haven't already
2230
pip install uv
2331

32+
# Install the package
33+
uv pip install isnt_that_odd
34+
```
35+
36+
### Using uvx (Run without installation)
37+
38+
```bash
39+
# Install uv if you haven't already
40+
pip install uv
41+
42+
# Run CLI commands directly without installing
43+
uvx isnt_that_odd check 42
44+
uvx isnt_that_odd benchmark --count 10
45+
```
46+
47+
### Development Installation
48+
49+
```bash
2450
# Clone the repository
25-
git clone https://github.com/yourusername/isnt_that_odd.git
51+
git clone https://github.com/LaunchPlatform/isnt_that_odd.git
2652
cd isnt_that_odd
2753

2854
# Install dependencies

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ dev = [
4141
]
4242

4343
[project.urls]
44-
Homepage = "https://github.com/yourusername/isnt_that_odd"
45-
Repository = "https://github.com/yourusername/isnt_that_odd.git"
46-
Issues = "https://github.com/yourusername/isnt_that_odd/issues"
44+
Homepage = "https://github.com/LaunchPlatform/isnt_that_odd"
45+
Repository = "https://github.com/LaunchPlatform/isnt_that_odd.git"
46+
Issues = "https://github.com/LaunchPlatform/isnt_that_odd/issues"
4747

4848
[tool.hatch.build.targets.wheel]
4949
packages = ["src/isnt_that_odd"]

0 commit comments

Comments
 (0)