feat: complete README with config reference, security guidance, and screenshots#94
Merged
Conversation
…creenshots - Add Security section: authentication requirements, allow_value_preview caution, CSRF handling, and rate-limiting/hardening recommendations - Add Screenshots section with per-section descriptions linking to releases - Add connects_to to the General configuration reference (was in the initializer template but missing from the README config block) - Collapse v1.0.0 ROADMAP section — all items now complete Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Creates docs/screenshots/ with named slots for the five key views. Replace the releases-page reference with inline markdown image tags so screenshots render directly in the README once PNGs are dropped in. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
A single GIF tour shows the app better than static screenshots. Drop docs/screenshots/demo.gif in to populate the README image. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Expand description to enumerate key features across all three sections. Add docs/ to the files glob so demo.gif ships with the published gem. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <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.
Closes #52
Summary
authenticate),allow_value_previewcaution for sensitive data, CSRF handling via Turbo, and rate-limiting/hardening recommendations (non-guessable mount path, IP restriction, Rack::Attack)connects_toadded to the General configuration block (it was in the install generator template but missing from the README)Test plan
bundle exec rspec— all examples pass (docs-only change)connects_to🤖 Generated with Claude Code