Skip to content

Commit

Permalink
fix: update readme re: support and use of native fetch
Browse files Browse the repository at this point in the history
update version
  • Loading branch information
ViolanteCodes committed Apr 10, 2024
1 parent 32b1df2 commit b193bca
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

For a comprehensive list of examples, check out the [API documentation](https://buttercms.com/docs/api/).

ButterCMS-JS version 2 will be supported until January 2025. Version 3 is slated for launch in November 2024 when Node v20 is moved to maintenance mode.

## Installation

Requires Node.js version 18 or greater.
Expand All @@ -22,6 +24,12 @@ Butter can also be included directly in HTML:
```
<!-- {x-release-please-end} -->

## Native Fetch

ButterCMS-JS version 2 will be using the native fetch API. This means that the fetch API will be used to make requests to the ButterCMS API. This is a breaking change for anyone using version 1 of the ButterCMS-JS package.

Native fetch is built into Node v18 as well as all modern browsers. This lessens the need for third-party fetch libraries and achieves consistency between Node and browser environments.

## Overview

Every resource is accessed via your butter instance:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "buttercms",
"version": "2.0.0",
"version": "2.0.1",
"description": "ButterCMS API Client",
"keywords": [
"buttercms",
Expand Down

0 comments on commit b193bca

Please sign in to comment.