From 10719a3778cc78ba4866560135553756db8d4671 Mon Sep 17 00:00:00 2001 From: CaioHenriquexD Date: Wed, 14 Jan 2026 06:11:07 +0100 Subject: [PATCH] Add project structure documentation Explains repository layout for new contributors --- docs/PROJECT_STRUCTURE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/PROJECT_STRUCTURE.md diff --git a/docs/PROJECT_STRUCTURE.md b/docs/PROJECT_STRUCTURE.md new file mode 100644 index 00000000..7514759a --- /dev/null +++ b/docs/PROJECT_STRUCTURE.md @@ -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.