From 05131715bb389c56bf41bf561d6ceec429269efa Mon Sep 17 00:00:00 2001 From: kan_shimizu Date: Wed, 24 Apr 2024 16:07:51 +0900 Subject: [PATCH 1/3] =?UTF-8?q?=E3=82=BB=E3=83=AB=E3=83=95=E3=83=9B?= =?UTF-8?q?=E3=83=9B=E3=82=B9=E3=83=86=E3=82=A3=E3=83=B3=E3=82=B0=E3=81=AE?= =?UTF-8?q?=E6=89=8B=E9=A0=86=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d6dc5fe..ad6d24e 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,9 @@ It helps you to use microCMS from JavaScript and Node.js applications. ### Install -Install npm package. +#### Node.js -> [!IMPORTANT] -> v3.0.0 or later requires Node.js **v18 or higher**. +Install npm package. ```bash $ npm install microcms-js-sdk @@ -21,8 +20,21 @@ or $ yarn add microcms-js-sdk ``` -> [!WARNING] -> The hosting service (unpkg.com) is not related to microCMS. For production use, we recommend self-hosting on your own server. +> [!IMPORTANT] +> v3.0.0 or later requires Node.js **v18 or higher**. + +#### Browser（Self-hosting） + +Download and unzip `microcms-js-sdk-x.y.z.zip` from the [releases page](https://github.com/microcmsio/microcms-js-sdk/releases). Then, host it on any server of your choice and use it. +The target file is `./dist/umd/microcms-js-sdk.js`. + +```html + +``` + +#### Browser（CDN） + +Please load and use the URL provided by an external provider. ```html @@ -32,6 +44,9 @@ or ``` +> [!WARNING] +> The hosting service (unpkg.com) is not related to microCMS. For production use, we recommend self-hosting on your own server. + ### How to use First, create a client. From 2ce277b6706b918810515f60f929e5a3d6523690 Mon Sep 17 00:00:00 2001 From: kan_shimizu Date: Wed, 24 Apr 2024 16:20:35 +0900 Subject: [PATCH 2/3] =?UTF-8?q?CDN=E3=81=AE=E5=88=A9=E7=94=A8=E5=85=88?= =?UTF-8?q?=E3=82=92jsdelivr=E3=81=AB=E5=A4=89=E6=9B=B4=E3=81=A8=E5=BE=AE?= =?UTF-8?q?=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ad6d24e..04d2a09 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,7 @@ $ yarn add microcms-js-sdk #### Browser（Self-hosting） -Download and unzip `microcms-js-sdk-x.y.z.zip` from the [releases page](https://github.com/microcmsio/microcms-js-sdk/releases). Then, host it on any server of your choice and use it. -The target file is `./dist/umd/microcms-js-sdk.js`. +Download and unzip `microcms-js-sdk-x.y.z.tgz` from the [releases page](https://github.com/microcmsio/microcms-js-sdk/releases). Then, host it on any server of your choice and use it. The target file is `./dist/umd/microcms-js-sdk.js`. ```html @@ -37,11 +36,11 @@ The target file is `./dist/umd/microcms-js-sdk.js`. Please load and use the URL provided by an external provider. ```html - + or - + ``` > [!WARNING] From 3cf2143c0a590506c1d1034dfbac6e214e38bb8a Mon Sep 17 00:00:00 2001 From: kan_shimizu Date: Wed, 24 Apr 2024 17:22:21 +0900 Subject: [PATCH 3/3] =?UTF-8?q?=E3=83=90=E3=83=BC=E3=82=B8=E3=83=A7?= =?UTF-8?q?=E3=83=B3=E5=80=A4=E3=81=AE=E8=BF=BD=E5=BE=93?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04d2a09..27430d4 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Download and unzip `microcms-js-sdk-x.y.z.tgz` from the [releases page](https:// Please load and use the URL provided by an external provider. ```html - + or