From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Thu, 14 Oct 2021 13:04:20 +0000 (+0200)
Subject: chore: better readme [skip ci]
X-Git-Tag: @pinia/nuxt@0.0.7~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=cabb191e7f505df7e7e9128b08c28627e95f2415;p=thirdparty%2Fvuejs%2Fpinia.git

chore: better readme [skip ci]
---

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)