Skip to content

docs: overhaul README - #5

Merged
V3RON merged 1 commit into
mainfrom
docs/readme-overhaul
Jul 17, 2026
Merged

V3RON merged 1 commit into
mainfrom
docs/readme-overhaul

Conversation

@V3RON

@V3RON V3RON commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Explains the problem Pitlane solves and its key features
  • Adds a Getting started section
  • Documents every config.json property in a table, with defaults sourced from src/core/config.ts
  • Drops the contributor-facing Releases section

Test plan

  • pnpm format

Expands the README to explain what problem Pitlane solves and its key
features, adds a getting-started section, and documents every config.json
property with defaults in a table.
@V3RON
V3RON merged commit cfa52cf into main Jul 17, 2026
2 checks passed
@V3RON
V3RON deleted the docs/readme-overhaul branch July 17, 2026 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant