Skip to content

Commit 765bc9c

Browse files
authored
Merge pull request #78 from microcmsio/docs/self-hosting
ファイルの利用方法の案内の整備
2 parents fe3eff5 + 3cf2143 commit 765bc9c

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@ It helps you to use microCMS from JavaScript and Node.js applications.
88

99
### Install
1010

11-
Install npm package.
11+
#### Node.js
1212

13-
> [!IMPORTANT]
14-
> v3.0.0 or later requires Node.js **v18 or higher**.
13+
Install npm package.
1514

1615
```bash
1716
$ npm install microcms-js-sdk
@@ -21,17 +20,32 @@ or
2120
$ yarn add microcms-js-sdk
2221
```
2322

24-
> [!WARNING]
25-
> The hosting service (unpkg.com) is not related to microCMS. For production use, we recommend self-hosting on your own server.
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`.
2629

2730
```html
28-
<script src="https://unpkg.com/microcms-js-sdk@3.1.0/dist/umd/microcms-js-sdk.js"></script>
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>
2940

3041
or
3142

32-
<script src="https://unpkg.com/microcms-js-sdk@latest/dist/umd/microcms-js-sdk.js"></script>
43+
<script src="https://cdn.jsdelivr.net/npm/microcms-js-sdk/dist/umd/microcms-js-sdk.min.js"></script>
3344
```
3445

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+
3549
### How to use
3650

3751
First, create a client.

0 commit comments

Comments
 (0)