Skip to content

Commit 9384acd

Browse files
committed
[add] options information
1 parent 3153691 commit 9384acd

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,24 @@ export default {
2121
serviceDomain: "YOUR_DOMAIN", // YOUR_DOMAIN is the XXXX part of XXXX.microcms.io
2222
apiKey: "YOUR_API_KEY",
2323
},
24+
mode: process.env.NODE_ENV === 'production' ? 'server' : 'all',
2425
},
2526
};
2627
```
2728

29+
#### options.serviceDomain
30+
`String`
31+
Your service id, which is a subdomain of microCMS.
32+
33+
#### options.apiKey
34+
`String`
35+
Your api-key.
36+
It can be obtained from the service settings.
37+
38+
#### mode
39+
`String` (can be `client` or `server`)
40+
If defined, the file will be included only on the respective (client or server) side.
41+
2842
### Hot to use
2943
This package uses [microcms-js-sdk](https://github.com/microcmsio/microcms-js-sdk).
3044
You can get microCMS client (`$microcms`) from `context`.

0 commit comments

Comments
 (0)