From b193bcad47b7db77f86290bf7976be4191ec87c3 Mon Sep 17 00:00:00 2001 From: ViolanteCodes Date: Wed, 10 Apr 2024 10:00:00 -0400 Subject: [PATCH] fix: update readme re: support and use of native fetch update version --- README.md | 8 ++++++++ package.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c3b82b6..bfc12e5 100644 --- a/README.md +++ b/README.md @@ -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. @@ -22,6 +24,12 @@ Butter can also be included directly in HTML: ``` +## 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: diff --git a/package.json b/package.json index 13cc5d3..95bc866 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "buttercms", - "version": "2.0.0", + "version": "2.0.1", "description": "ButterCMS API Client", "keywords": [ "buttercms",