Skip to content

Rewrite README - #11

Merged
sillyash merged 1 commit into
mainfrom
update-readme
Jul 3, 2026
Merged

Rewrite README#11
sillyash merged 1 commit into
mainfrom
update-readme

Conversation

@sillyash

@sillyash sillyash commented Jul 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replaced the stale README (referenced a now-removed npm run deploy script) with one that matches the current stack: Vue 3 + Vuetify 3 via Vite, file-based routing/layouts, Pinia, ESLint.
  • Added a project structure overview and documented the actual dev scripts (dev, build, preview, lint).
  • Documented the CI/CD pipeline (lint/build/audit on PR+push, auto-deploy to Pages on push to main).

Test plan

  • Read through for accuracy against current package.json scripts and .github/workflows/ci-cd.yml

The old README referenced npm run deploy, which no longer exists now
that deployment is automated via the ci-cd.yml workflow, and gave no
detail on the actual stack, project layout, or dev scripts. Rewrote it
to reflect the current Vue 3 + Vuetify setup, file-based routing, dev
scripts, and the CI/CD pipeline.
@sillyash
sillyash merged commit d320dbb into main Jul 3, 2026
3 checks passed
@sillyash
sillyash deleted the update-readme branch July 3, 2026 12:02
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