From 7bdbee31664fffbacf1626bf9f5292ba750c9d3e Mon Sep 17 00:00:00 2001 From: LENNOXT Date: Mon, 12 Jan 2026 17:29:28 +0100 Subject: [PATCH] Document project structure in README Adds a short section explaining the repository folder layout. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2ef80bb5..94759130 100644 --- a/README.md +++ b/README.md @@ -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.