docs(readme): refresh for v1.0.0#16
Merged
Merged
Conversation
Bring the README in line with the current codebase: - S3/MinIO storage is implemented (Go + worker), not "coming soon" - Correct env vars: BUCKET_PROVIDER/S3_*, REDIS_CONNECTION_STRING, required ENCRYPTION_KEY (32 bytes), HOST/PORT, AUTO_MIGRATE - Drop non-existent docker-compose.yml and requirements.txt steps; document GHCR images + per-dockerfile builds - Add Observability and Releases sections; document staging vs LTS tags - Update project structure (storagex, observability, worker/storage factory) - Fix test commands (task test / pytest worker/tests), contributing flow Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes the README to match the current codebase and the v1.0.0 LTS release.
Corrected
BUCKET_PROVIDER/S3_*,REDIS_CONNECTION_STRING, requiredENCRYPTION_KEY(32 bytes),HOST/PORT,AUTO_MIGRATEdocker-compose.ymlandrequirements.txtstepsAdded
.version→ ldflags)staging)🤖 Generated with Claude Code