README.md

@@ -1,48 +1,62 @@
-# Better uwuzu SDK
+# Better uwuzu SDK
-[uwuzu.js](https://github.com/PutonFPS/uwuzu.js)みたいなやつです。uwuzuのAPIがいじれます。
+[uwuzu.js](https://github.com/PutonFPS/uwuzu.js)みたいなやつです。uwuzuのAPIがいじれます。
-
+
-# 使い方
+# 使い方
-## インストール
+## インストール
-初期リリース出たら書きます
+```bash
-
+# npm
-## 初期化
+npm install git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.0
-```ts
+
-import uwuzu from "better-uwuzu-sdk";
+# yarn
-import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
+yarn add git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.0
-
+
-const client = new uwuzu<ApiMap>({
+# pnpm
-  origin: "https://uwuzu.net",
+pnpm add git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.0
-});
+```
-
+> **NOTE**
-try {
+> このSDKはnpmリポジトリがありません。Gitリポジトリを使用しています。
-  client.token = "APITOKEN";
+
-} catch (err) {
+> **WARNING**
-  console.error(err);
+> `#main`でのインストールもできますが破壊的変更の際に面倒だと思います。サポートしません。
-}
+
-```
+## 初期化
-型とJSDoc見ればわかります。トークンはなくても`serverinfo-api`や`token/get`は動きますが大体の事例では入れると思います。`uwuzu().token`の`set`は検証を行うわけではありませんが64文字でない、空文字列であるなどの場合はエラーが発生します。
+```ts
-
+import uwuzu from "better-uwuzu-sdk";
-## APIリクエスト
+import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
-```ts
+
-import uwuzu from "better-uwuzu-sdk";
+const client = new uwuzu<ApiMap>({
-import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
+  origin: "https://uwuzu.net",
-
+});
-const client = new uwuzu<ApiMap>({
+
-  origin: "https://uwuzu.net",
+try {
-});
+  client.token = "APITOKEN";
-
+} catch (err) {
-try {
+  console.error(err);
-  client.token = "APITOKEN";
+}
-  
+```
-  const me = await client.request("me/");
+型とJSDoc見ればわかります。トークンはなくても`serverinfo-api`や`token/get`は動きますが大体の事例では入れると思います。`uwuzu().token`の`set`は検証を行うわけではありませんが64文字でない、空文字列であるなどの場合はエラーが発生します。
-  
+
-  if (me.error_code) {
+## APIリクエスト
-    throw new Error(me.error_code);
+```ts
-  }
+import uwuzu from "better-uwuzu-sdk";
-  
+import type ApiMap from "better-uwuzu-sdk/1.6.11/map";
-  console.log(`あなたは${me.username}です。`);
+
-} catch (err) {
+const client = new uwuzu<ApiMap>({
-  console.error(err);
+  origin: "https://uwuzu.net",
-}
+});
-```
+
+try {
+  client.token = "APITOKEN";
+  
+  const me = await client.request("me/");
+  
+  if (me.error_code) {
+    throw new Error(me.error_code);
+  }
+  
+  console.log(`あなたは${me.username}です。`);
+} catch (err) {
+  console.error(err);
+}
+```
 普通のSDKです。`uwuzu().request()`の第一引数はエンドポイント、第二引数はbodyです。bodyにトークンは自動入力されるので上記の例のように省略できます。