Skip to content

docs(readme): add release, downloads, and license badges - #94

Merged
luoxuanzao merged 1 commit into
mainfrom
docs/readme-badges
Oct 11, 2026
Merged

luoxuanzao merged 1 commit into
mainfrom
docs/readme-badges

Conversation

@luoxuanzao

Copy link
Copy Markdown
Member

Summary

Adds shields.io badges under the title of README.md and README.zh-CN.md:

  • release — latest GitHub release tag
  • downloads — total downloads from Obsidian's community-plugin-stats.json, keyed by the qoderian plugin id
  • license — repository license

The badges render on GitHub and on the Obsidian community plugin page, which displays the README. They update on their own, so new releases don't need README edits.

Test plan

  • Fetched each badge URL; they currently render release: v1.0.17, downloads: 3448, license: MIT.

Shields.io badges under the title of both READMEs. Downloads come from Obsidian's community-plugin-stats.json keyed by the plugin id, so they update without README edits.
@luoxuanzao
luoxuanzao merged commit cded85e into main Oct 11, 2026
10 checks passed
@luoxuanzao
luoxuanzao deleted the docs/readme-badges branch October 11, 2026 02:15
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.

1 participant