summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2021-10-16 23:57:02 +0900
committerGitHub <noreply@github.com>2021-10-16 23:57:02 +0900
commit8ba56df54e8ba78d43760a4e1490aaa346c66b45 (patch)
tree5b44ed28874777b7cef4d646c318c890de843696
parentUpdate misskey-js.api.md (diff)
downloadmisskey-8ba56df54e8ba78d43760a4e1490aaa346c66b45.tar.gz
misskey-8ba56df54e8ba78d43760a4e1490aaa346c66b45.tar.bz2
misskey-8ba56df54e8ba78d43760a4e1490aaa346c66b45.zip
Update README.md
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 98884109e9..09e72166a1 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ npm i misskey-js
```
# Usage
-インポートは以下のようにまとめて行えます。
+インポートは以下のようにまとめて行うと便利です。
``` ts
import * as Misskey from 'misskey-js';
@@ -31,8 +31,11 @@ import * as Misskey from 'misskey-js';
便宜上、以後のコード例は上記のように`* as Misskey`としてインポートしている前提のものになります。
-まとめてインポートを行うとTree-Shakingできなくなるので、適宜変更をおすすめします。
+ただし、このインポート方法だとTree-Shakingできなくなるので、コードサイズが重要なユースケースでは以下のような個別インポートをお勧めします。
+``` ts
+import { api as misskeyApi } from 'misskey-js';
+```
## Authenticate
todo