Skip to content

README hero, screenshots, demo GIF, badges and social preview - #215

Merged
MehdiMamas merged 1 commit into
mainfrom
readme-201
Nov 14, 2026
Merged

MehdiMamas merged 1 commit into
mainfrom
readme-201

Conversation

@MehdiMamas

Copy link
Copy Markdown
Owner

Closes #201. Part of #199.

  • README opens with logo, one-line pitch, shields.io badges (CI, release, license, downloads, platforms) and a demo GIF.
  • Light and dark screenshots of the groups, group and settings screens, taken from the UI with the fake backend (made-up people and groups; avatars blocked so initials show). Added What you get and How it works.
  • docs/images/social-preview.png (1280x640).
  • Repository topics added: configuration, dotfiles, github, linux, macos, windows, team-collaboration.

Checks: docs and images only, no code. Rendered on the branch to confirm images load.

Left for the owner: upload docs/images/social-preview.png under Settings, Social preview (GitHub has no API for it).

Before: the README began with plain text and said "No screenshots yet".
Now: it opens with logo, badges and a demo GIF, shows light and dark screenshots, and adds What you get and How it works.
@MehdiMamas
MehdiMamas merged commit 264558b into main Nov 14, 2026
3 checks passed
@MehdiMamas
MehdiMamas deleted the readme-201 branch November 14, 2026 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Launch 2/5: README hero, screenshots, GIF, badges, topics, social preview

1 participant