Skip to content

Commit f3c1d64

Browse files
committed
docs: update README.md
1 parent b74f972 commit f3c1d64

File tree

1 file changed

+0
-55
lines changed

1 file changed

+0
-55
lines changed

README.md

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
11
# 🪝 vue-use-media-recorder
22

3-
A minimalist starting point for your next Vue 3 composable.
4-
5-
- 🧩 **TypeScript** by default
6-
- 📦 **PNPM** as package manager
7-
- 🤹 Testing using [**Vitest**](https://vitest.dev)
8-
- ☑️ Linting using [**@antfu/eslint-config**](https://github.com/antfu/eslint-config)
9-
- 🌐 [**Nuxt 3**](https://nuxtjs.org) as a playground
10-
- 📸 Playgrounds using [**Vite**](https://vitejs.dev) and [Nuxt](https://nuxt.com/)
11-
- 🚚 Built using [**unbuild**](https://github.com/unjs/unbuild)
12-
- 📚 Documentation using [**Vitepress**](https://vitepress.dev)
13-
14-
> Edit [variables](#to-do), implement, test, publish 🏎
15-
163
## Commands
174

185
Build the package:
@@ -68,45 +55,3 @@ Preview Nuxt environment:
6855
```bash
6956
pnpm start:nuxt
7057
```
71-
72-
## Why
73-
74-
This repository is useful if you want to start a new Vue composable, or a general Vue package.
75-
76-
I used it personally for:
77-
78-
- [**@vueuse/motion**](https://github.com/vueuse/motion)
79-
- [**@vueuse/gesture**](https://github.com/vueuse/gesture)
80-
- [**@vueuse/sound**](https://github.com/vueuse/sound)
81-
82-
I try to keep it updated when I upgrade my own workflow!
83-
84-
## Workflow
85-
86-
I usually develop with the `dev:nuxt` command.
87-
88-
Your changes on any file will be reloaded by **Nuxt**, and you can start trying SSR capabilities of your composable easily!
89-
90-
The general Nuxt environment does not differ from a classic Vue app.
91-
92-
## To-Do
93-
94-
- [ ] Edit package.json `name`, `description`, `repository` and `author` keys.
95-
- [ ] Rename all `vue-composable-starter` with your package name.
96-
- [ ] Rename `VueComposableStarterPluginOptions` with your plugin options.
97-
- [ ] Remove .vscode folder (containing recommended extensions)
98-
- [ ] Edit README.md.
99-
- [ ] Implement my composable.
100-
- [ ] Test my composable.
101-
- [ ] Document my composable.
102-
- [ ] Publish on [NPM](npmjs.com), [awesome-vue](https://github.com/vuejs/awesome-vue), [vue-forum](https://forum.vuejs.org/), [Vue Discord](https://fr.vuejs.org/v2/guide/join.html).
103-
104-
## Contributing
105-
106-
You are more than welcome to improve this starter template.
107-
108-
Just submit your changes via pull request and I will review them before merging.
109-
110-
If you are making a fix on the template, you can use the `main` branch and send a pull request.
111-
112-
If you are adding a new features, please create a new branch with a name describing your feature (`my-new-feature`), push to your branch and then submit a pull request.

0 commit comments

Comments
 (0)