Skip to content

Add project structure documentation #74

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
CaioHenriquexD wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add project structure documentation #74

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
13 changes: 13 additions & 0 deletions docs/PROJECT_STRUCTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Project Structure

This document briefly explains the purpose of each main folder.

## Root files
- `README.md` — general project overview
- `requirements.txt` — Python dependencies

## Directories
- `examples/` — sample scripts demonstrating API usage
- `kalshi/` — core client logic and helpers

This structure is intentionally minimal to make onboarding easier.