Skip to content

docs: revamp root README into a landing page - #1101

Merged
Lyokone merged 1 commit into
masterfrom
docs/revamp-root-readme
Jul 23, 2026
Merged

docs: revamp root README into a landing page#1101
Lyokone merged 1 commit into
masterfrom
docs/revamp-root-readme

Conversation

@Lyokone

@Lyokone Lyokone commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Summary

Rewrites the root README.md from a bare package list into an attractive GitHub landing page, aimed at making the repo more welcoming and driving adoption.

The previous root README was ~30 lines and — via a leftover copy-paste — actually mis-described the plugin as one that "display[s] local notifications within Flutter applications."

What's new

  • Hero section — emoji title, one-line pitch, and the six supported platforms up front.
  • Badge row — pub version, pub likes, pub points, codecov, license.
  • Quick-nav links — Docs · Live web demo · pub.dev · Feedback.
  • "Why Location?" feature highlights.
  • Platform support matrix broken down by feature (one-time / stream / background / permissions), accurately reflecting that background updates are Android + iOS only.
  • YouTube demo thumbnail (carried from the package README).
  • Copy-pasteable quick start — a minimal, correct snippet (service check → permission → one-time fix + stream).
  • Packages table with per-package pub badges.
  • Contributing section, maintainers, and MIT license.

Docs-only change — no code touched.

@Lyokone
Lyokone merged commit 31a8aa0 into master Jul 23, 2026
6 checks passed
@Lyokone
Lyokone deleted the docs/revamp-root-readme branch July 23, 2026 15:14
@cedvdb

cedvdb commented Aug 10, 2026

Copy link
Copy Markdown

@Lyokone FYI the web demo has a 404

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.

2 participants