Skip to content

Commit

Permalink
docs: imrpove migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lihbr committed Aug 10, 2021
1 parent 890bb62 commit 25c39b9
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [🛠  Usage](#usage)
- [📚  Configuration References](#configuration-references)
- [📚  Configuration References](#configuration-references)
- [🛶  Migration From `0.0.x`](#migration-from-00x)
- [🛶  Migrating From `0.0.x`](#migrating-from-00x)

## Installation

Expand Down Expand Up @@ -366,9 +366,16 @@ type PrismicPluginOptions = {
}
```

## Migration From `0.0.x`
## Migrating From `0.0.x`

Plugin options have changed from `0.0.x` to `0.1.x`, to migrate you need to update the plugin configuration:
Package exports have changed from `0.0.x` to `0.1.x`, `pluginPrismic` is not longer default exported:

```diff
- const pluginPrismic = require("eleventy-plugin-prismic");
+ const { pluginPrismic } = require("eleventy-plugin-prismic");
```

Plugin options have also changed, to migrate you need to update the plugin configuration as follows:

```diff
{
Expand Down

0 comments on commit 25c39b9

Please sign in to comment.