From cabb191e7f505df7e7e9128b08c28627e95f2415 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Thu, 14 Oct 2021 15:04:20 +0200 Subject: [PATCH] chore: better readme [skip ci] --- packages/nuxt/README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md index d7dc119d..ffa8fac7 100644 --- a/packages/nuxt/README.md +++ b/packages/nuxt/README.md @@ -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) -- 2.47.3