The sqlok project is missing comprehensive documentation. Users cannot understand the project's purpose, features, or how to use it without a
README.
Goals
Acceptance Criteria
- README.md exists at project root
- Includes overview explaining sqlok's purpose (PostgreSQL schema manager + query builder)
- Documents key features with code examples
- Contains quick start section with SELECT, INSERT examples
- Describes internal architecture (builder.go, schema/, cli/)
- Includes development setup (make test, CI/CD info)
- Lists all external dependencies
- Provides roadmap for future features
The sqlok project is missing comprehensive documentation. Users cannot understand the project's purpose, features, or how to use it without a
README.
Goals
Acceptance Criteria