Skip to content

Add project overview documentation #69

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

Add project overview documentation #69

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

This repository provides starter Python code for interacting with the Kalshi API.

It is intended to help developers quickly understand:
- How authentication works
- How to structure API requests
- How to handle basic responses

This document gives a high-level overview for new contributors.