Skip to content

docs: restyle README, host demo videos on R2, use official download stats - #44

Merged
ClaudiaFang merged 3 commits into
mainfrom
docs/readme-restyle
Jul 6, 2026
Merged

docs: restyle README, host demo videos on R2, use official download stats#44
ClaudiaFang merged 3 commits into
mainfrom
docs/readme-restyle

Conversation

@ClaudiaFang

@ClaudiaFang ClaudiaFang commented Jul 6, 2026

Copy link
Copy Markdown
Member

Summary

This PR modernizes the repository's documentation by:

  • README.md redesign: Rewrote following obsidian-pm plugin's structure with centered header, tagline, badges, organized feature sections, and clear quick-start guide
  • Self-hosted demo videos: Migrated from GitHub user-attachments URLs to Cloudflare R2 (blog-assets.firstsun.org) for better reliability and control
  • USAGE_zh.md sync: Added matching badge row and video hosting migration to keep translations in sync
  • Official download metrics: Replaced GitHub-release-based Downloads badge with one reading Obsidian's official community-plugin-stats.json, linking to the plugin's obsidian.md page

Test Plan

  • README.md renders correctly in GitHub (badges align, spacing consistent, links work)
  • USAGE_zh.md badges and video links are functional
  • Cloudflare R2 demo video links are accessible and play correctly
  • All external badge links (CI, Release, License, Obsidian) resolve properly
  • Plugin installation and core workflows still function as expected
  • No build/lint errors introduced

Generated with Claude Code

@ClaudiaFang
ClaudiaFang merged commit 0a4cff5 into main Jul 6, 2026
11 of 12 checks passed
@ClaudiaFang
ClaudiaFang deleted the docs/readme-restyle branch July 6, 2026 02:31
@sonarqubecloud

sonarqubecloud Bot commented Jul 6, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

ClaudiaFang pushed a commit that referenced this pull request Jul 7, 2026
@semantic-release-bot
chore(release): 1.2.1 [skip ci]
ef238ce 
## [1.2.1](1.2.0...1.2.1) (2026-07-07)

### Bug Fixes

* **compat:** support Obsidian down to 1.11.0 ([d896015](d896015))

### Documentation

* restyle README, host demo videos on R2, use official download stats ([#44](#44)) ([0a4cff5](0a4cff5))
@ClaudiaFang

ClaudiaFang commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

🎉 This PR is included in version 1.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ClaudiaFang