Rework README: user-friendly feature list and get started guide #47
Notifications
Total Time Spent: 6 seconds
poslop
6 seconds
No due date set.
Dependencies
No dependencies set.
Reference: poslop/palette#47
Reference in New Issue
Block a user
Current README is API/dev-focused. Rework it to welcome all readers: a friendly intro on what Palette is, a features list (paste cans, password lock, expiry, burn-after-read, custom URLs, syntax highlighting, language auto-detection, rate limiting, API-first design, self-hostable single binary), a Get Started section (run locally, or docker), and screenshots of the UI. Move the detailed API docs to docs/API.md and link to it. Keep the tone plain and welcoming, not chatty.
Reworked in
238dc96: user-first intro, Features list, Get Started (source+docker image), screenshots table referencing docs/palette-previews, config table, single API example pointing to the new docs/API.md (all previous API detail moved there).