microcms-js-sdk 3.1.0 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,10 +8,9 @@ It helps you to use microCMS from JavaScript and Node.js applications.
|
|
|
8
8
|
|
|
9
9
|
### Install
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
#### Node.js
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
> v3.0.0 or later requires Node.js **v18 or higher**.
|
|
13
|
+
Install npm package.
|
|
15
14
|
|
|
16
15
|
```bash
|
|
17
16
|
$ npm install microcms-js-sdk
|
|
@@ -21,16 +20,32 @@ or
|
|
|
21
20
|
$ yarn add microcms-js-sdk
|
|
22
21
|
```
|
|
23
22
|
|
|
24
|
-
|
|
23
|
+
> [!IMPORTANT]
|
|
24
|
+
> v3.0.0 or later requires Node.js **v18 or higher**.
|
|
25
|
+
|
|
26
|
+
#### Browser（Self-hosting）
|
|
27
|
+
|
|
28
|
+
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`.
|
|
25
29
|
|
|
26
30
|
```html
|
|
27
|
-
<script src="
|
|
31
|
+
<script src="./microcms-js-sdk.js"></script>
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
#### Browser（CDN）
|
|
35
|
+
|
|
36
|
+
Please load and use the URL provided by an external provider.
|
|
37
|
+
|
|
38
|
+
```html
|
|
39
|
+
<script src="https://cdn.jsdelivr.net/npm/microcms-js-sdk@3.1.1/dist/umd/microcms-js-sdk.min.js"></script>
|
|
28
40
|
|
|
29
41
|
or
|
|
30
42
|
|
|
31
|
-
<script src="https://
|
|
43
|
+
<script src="https://cdn.jsdelivr.net/npm/microcms-js-sdk/dist/umd/microcms-js-sdk.min.js"></script>
|
|
32
44
|
```
|
|
33
45
|
|
|
46
|
+
> [!WARNING]
|
|
47
|
+
> The hosting service (unpkg.com) is not related to microCMS. For production use, we recommend self-hosting on your own server.
|
|
48
|
+
|
|
34
49
|
### How to use
|
|
35
50
|
|
|
36
51
|
First, create a client.
|