]> git.ipfire.org Git - thirdparty/vuejs/pinia.git/commitdiff
chore: better readme [skip ci]
authorEduardo San Martin Morote <posva13@gmail.com>
Thu, 14 Oct 2021 13:04:20 +0000 (15:04 +0200)
committerEduardo San Martin Morote <posva13@gmail.com>
Thu, 14 Oct 2021 13:04:20 +0000 (15:04 +0200)
packages/nuxt/README.md

index d7dc119d562981b7e8c1216cde92b3bde739fdac..ffa8fac76cf590a068be589b05575406d814886f 100644 (file)
@@ -1,3 +1,25 @@
-# Nuxt 2/3 module
+# `@pinia/nuxt`
 
-Note this is a WIP module for Nuxt, it isn't available yet.
+> Nuxt 2 & 3 module
+
+## Installation
+
+```sh
+npm i @pinia/nuxt
+```
+
+## Usage
+
+Add to `buildModules` in `nuxt.config.js`:
+
+```js
+export default {
+  buildModules: [['@pinia/nuxt', { disableVuex: true }]],
+}
+```
+
+Note you also need `@nuxtjs/composition-api` if you are using Nuxt 2 without Bridge. [Refer to docs for more](https://pinia.esm.dev/ssr/nuxt.html).
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)