Skip to content

Commit 3c79d47

Browse files
committed
README Adjustments
1 parent 21c995f commit 3c79d47

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> My personal repo template for developing Vue 3 libraries in a monorepo powered by yarn workspaces
44
5-
**STATE**: WIP - under development ⚠️ This may not yet work as intended in some places/scenarios.
5+
**STATE**: Still working on this here and ther, but it's working fine, usually ☺️
66

77
## What is this and who is it for?
88

@@ -12,19 +12,18 @@ This template is primarily meant for myself (but you can of course you it any wa
1212

1313
As such, it is pretty opinionated, and probably does some things in way you don't like, or is missing something you deem essential. That's fine. Fork it and make it your own :)
1414

15-
It also uses a bunch of new/experimental things out of the Vue ecosystem (namely Vite and Vitepress), so expect some hick-ups while using those parts of the setup.
16-
1715
## Features
1816

1917
* ✅ Full Typescript support for the whole dev workflow
20-
* ⚡️ Lightning-fast dev workflow completely powered by Vite:
18+
* ⚡️ Ergonomic and easy workflow completely powered by Vite & PNPM:
2119
* 🎯 Build your libraries with [Vite](https://github.com/vitejs/vite)
2220
* ⛱️ Typechecking & Generating declaration files with `vue-tsc`(https://github.com/johnsoncodehk/volar/tree/master/vue-language-tools/vue-tsc)
2321
* 🏈 Integrated playground app powered by [Vite](https://github.com/vitejs/vite) as well
24-
* 📚 Documentation powered by [Vitepress](https://vitepress.vuejs.org)
2522
* 💊 Unit Tests with [Vitest](https://www.vitest.dev)
2623
* 🖍 Linting with `eslint` and `prettier`
2724
* [PLANNED] linting & fixing for staged files (`lint-staged`)
25+
* 📚 Documentation powered by [Vitepress](https://vitepress.vuejs.org)
26+
* Ready to be deployed to [Netlify](https://www.netlify.com)
2827

2928
## Documentation, FAQ and Troubleshooting
3029

0 commit comments

Comments
 (0)