Skip to content

Commit

Permalink
docs: update install step, fixes: #206
Browse files Browse the repository at this point in the history
  • Loading branch information
lihbr committed Mar 26, 2024
1 parent 0f2729a commit 7ec855b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,26 @@ Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.jso

Easily connect your Nuxt.js application to your content hosted on [Prismic][prismic].

- [ Release Notes](/CHANGELOG.md)
- [🏀 Online playground](https://stackblitz.com/github/nuxt-modules/prismic/tree/master/examples/minimal?file=pages%2Findex.vue)
- [📖  Documentation](https://prismic.nuxtjs.org)

## Features

<!-- Highlight some of the features your module provide here -->
- 🚀 &nbsp;Add Prismic to your Nuxt app in seconds;
- 🎣 &nbsp;Access Prismic SDK through composition and options API;
- 🖼 &nbsp;Prismic previews supported.

## Install
## Quick Setup

Install the module to your Nuxt application with one command:

```bash
npm install --save-dev @nuxtjs/prismic # or yarn add --dev @nuxtjs/prismic
npx nuxi module add prismic
```

Then, add `@nuxtjs/prismic` to the `modules` section of your Nuxt config and configure your Prismic API endpoint:
Then, configure your Prismic API endpoint:

```javascript
import { defineNuxtConfig } from 'nuxt'
Expand All @@ -42,6 +51,8 @@ export default defineNuxtConfig({
});
```

That's it! You can now use Prismic in your Nuxt app ✨

## Documentation

To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [module documentation][nuxt-docs] and [Prismic official documentation][prismic-docs].
Expand Down
2 changes: 1 addition & 1 deletion docs/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ cta:
secondary:
- Open on GitHub →
- https://github.com/nuxt-modules/prismic
snippet: npm install --save-dev @nuxtjs/prismic
snippet: npx nuxi module add prismic
---

#announce
Expand Down
5 changes: 4 additions & 1 deletion docs/content/1.get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@ main:
1. Install dependency

::code-group
```bash [nuxi]
npx nuxi module add prismic
```
```bash [Yarn]
yarn add --dev @nuxtjs/prismic
```
```bash [NPM]
```bash [npm]
npm install --save-dev @nuxtjs/prismic
```
::
Expand Down

0 comments on commit 7ec855b

Please sign in to comment.