Skip to content

docs: refresh readme & add sponsors update workflow#2049

Merged
CodeDredd merged 1 commit into
mainfrom
docs/readme-refresh
Jul 20, 2026
Merged

docs: refresh readme & add sponsors update workflow#2049
CodeDredd merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@CodeDredd

@CodeDredd CodeDredd commented Jul 20, 2026

Copy link
Copy Markdown
Owner

README

  • Rewritten for 2.0.0: short feature overview, a real quick-start (install + model definition in the new standard-decorator syntax + query), requirements matrix (pinia/Node/TS per major)
  • The vuex-orm comparison table moved into the docs (what-is-pinia-orm) and got updated on the way (morphToMany/morphedByMany are ✅ since long, decorators row now says standard decorators, migration-guide link)
  • Fixed the broken LICENCE link (file is LICENSE)

Sponsors

New sponsors.yml workflow: runs monthly (and via workflow_dispatch) and regenerates docs/public/sponsorkit with sponsorkit, committing with [skip-release].

⚠️ Setup needed once: create a repo secret SPONSORKIT_GITHUB_TOKEN — a classic PAT with read:user + read:org scopes (the Actions GITHUB_TOKEN can't read sponsorships).

Rewrites the readme for 2.0.0 (feature overview, quick start with the
standard decorator syntax, requirements matrix), moves the vuex-orm
comparison table into the what-is-pinia-orm docs page and adds a
monthly workflow that regenerates the sponsorkit images.
@CodeDredd
CodeDredd merged commit 05a9386 into main Jul 20, 2026
4 of 6 checks passed
@CodeDredd
CodeDredd deleted the docs/readme-refresh branch July 20, 2026 16:43
@github-actions github-actions Bot mentioned this pull request Jul 20, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.24%. Comparing base (b414611) to head (37b706c).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2049   +/-   ##
=======================================
  Coverage   99.24%   99.24%           
=======================================
  Files          83       83           
  Lines        3185     3185           
  Branches      562      562           
=======================================
  Hits         3161     3161           
  Misses         17       17           
  Partials        7        7           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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