Update README to reflect current features#515
Merged
Conversation
Rewrite the README to document all current features including: themes, comments, search, revision history, backlinks, draft workflow, scholar integration, configurable pages/post types, trusted proxies, and Docker deployment. Remove completed items from todo, update badges to point to main branch, add theming docs and quick start sections. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the project README to reflect the current state of the Go blog platform and provide clearer onboarding/usage details.
Changes:
- Update Codecov badge to track the
mainbranch. - Rewrite README feature list and add expanded Quick Start / theming documentation.
- Add an architecture summary and link TODOs to issue numbers.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Markdown posts with code syntax highlighting and table support | ||
| - Draft / publish workflow | ||
| - Post revision history with rollback | ||
| - Tags with tag cloud |
| - Post revision history with rollback | ||
| - Tags with tag cloud | ||
| - Configurable post types (blog posts, notes, etc.) | ||
| - Full-text search |
| - File uploads (images, PDFs, etc.) | ||
| - Internal and external backlink tracking | ||
| - Comments with markdown support, spam honeypot, and rate limiting | ||
| - RSS-ready sitemap generation |
Comment on lines
+43
to
+46
| - SQLite database (file-based, zero config) | ||
| - Docker support with tagged releases on Docker Hub | ||
| - Configurable trusted proxies for reverse proxy deployments (`TRUSTED_PROXIES` env var) | ||
| - GitHub Actions CI/CD |
Comment on lines
+62
to
66
| ### Behind a Reverse Proxy | ||
| Set `TRUSTED_PROXIES` so `X-Forwarded-For` headers are trusted for client IP resolution: | ||
| ```bash | ||
| TRUSTED_PROXIES=172.16.0.0/12 ./goblog | ||
| ``` |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #515 +/- ##
=======================================
Coverage ? 45.83%
=======================================
Files ? 8
Lines ? 2221
Branches ? 0
=======================================
Hits ? 1018
Misses ? 1061
Partials ? 142 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Summary
Complete rewrite of the README to accurately document the project's current state.
What changed
mastertomainbranch🤖 Generated with Claude Code