Skip to content

Update Readme#64

Merged
zedimytch merged 9 commits intomasterfrom
feature/readme
Mar 24, 2026
Merged

Update Readme#64
zedimytch merged 9 commits intomasterfrom
feature/readme

Conversation

@zedimytch
Copy link
Copy Markdown
Collaborator

@zedimytch zedimytch commented Mar 24, 2026

Note

Low Risk
Documentation-only updates plus a new config.example.json template; no runtime or behavior changes.

Overview
Improves onboarding docs in README.md by adding a clearer project description, local run instructions, and notes on configuration, bearer-token auth, permissions, and rate limiting.

Adds config.example.json as a template for local PostgreSQL/HTTP/environment settings to copy into config.json.

Written by Cursor Bugbot for commit 60e84b4. This will update automatically on new commits. Configure here.

@zedimytch zedimytch self-assigned this Mar 24, 2026
@zedimytch zedimytch added the Documentation Improvements or additions to documentation label Mar 24, 2026
@zedimytch zedimytch requested a review from Step7750 March 24, 2026 18:30
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Step7750 <Step7750@gmail.com>
@zedimytch zedimytch merged commit df93823 into master Mar 24, 2026
2 checks passed
@zedimytch zedimytch deleted the feature/readme branch March 24, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants