Skip to content

Commit

Permalink
add breaking changes notice for v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisburnell authored Jan 14, 2024
1 parent 546311e commit b3c3714
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

> Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.
## Breaking change for v2.0.0

Version 2.0.0 introduces a breaking change for those migrating from earlier versions of the plugin. This affects usage of the plugin from JavaScript files; specifically, you will need to make a small change to the way that you require() the plugin by removing an extra set of parentheses:

**v1.2.5 and below**

```javascript
require("@chrisburnell/eleventy-cache-webmentions")()
```

**v2.0.0**

```javascript
require("@chrisburnell/eleventy-cache-webmentions")
```

## Quick Guide

I wrote a quicker and simpler guide to getting this Eleventy plugin working that cuts out all the fluff and extra details.
Expand Down

0 comments on commit b3c3714

Please sign in to comment.