Skip to content

Document project structure in README #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LennoxT wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

Document project structure in README #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,11 @@ Install requirements.txt in a virtual environment of your choice and execute mai
pip install -r requirements.txt
python main.py
```
## Project Structure

- `examples/` – simple usage examples of the Kalshi API
- `kalshi/` – core client logic
- `tests/` – basic test cases
- `requirements.txt` – Python dependencies

This overview helps new users quickly understand the repository layout.