Skip to content

Add configuration documentation #72

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

Add configuration documentation #72

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

This document explains basic configuration expectations for the project.

## Environment Variables

The following values are expected to be provided by the user:
- API key
- API secret

These should never be hardcoded and must be provided securely.

## Local Setup

This project assumes the user manages their own environment setup.
Refer to official Kalshi documentation for credentials management.