From bfb6dd4c0f03bddb499da2e5ffb8428d9f10f1e0 Mon Sep 17 00:00:00 2001 From: xelons79 Date: Wed, 17 Dec 2025 19:43:27 +0100 Subject: [PATCH] docs: add project purpose section Clarifies the intended use of the starter code. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2ef80bb..4d3bfd3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ Example python code for accessing api-authenticated endpoints on [Kalshi](https: ## Installation Install requirements.txt in a virtual environment of your choice and execute main.py from within the repo. +## Project Purpose + +This repository provides example Python code for interacting with the Kalshi API. +It is intended for learning and experimentation rather than production use. + + ``` pip install -r requirements.txt python main.py