From 714a3b852c7f7b2ce9e01003750a7af443f9a47d Mon Sep 17 00:00:00 2001 From: Last2014 Date: Wed, 21 Jan 2026 13:37:28 +0000 Subject: [PATCH] =?UTF-8?q?Add:=20=E3=82=A4=E3=83=B3=E3=82=B9=E3=83=88?= =?UTF-8?q?=E3=83=BC=E3=83=AB=E6=89=8B=E9=A0=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 108 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 61 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 4cc8ba8..539e2b4 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,62 @@ -# Better uwuzu SDK -[uwuzu.js](https://github.com/PutonFPS/uwuzu.js)みたいなやつです。uwuzuのAPIがいじれます。 - -# 使い方 -## インストール -初期リリース出たら書きます - -## 初期化 -```ts -import uwuzu from "better-uwuzu-sdk"; -import type ApiMap from "better-uwuzu-sdk/1.6.11/map"; - -const client = new uwuzu({ - origin: "https://uwuzu.net", -}); - -try { - client.token = "APITOKEN"; -} catch (err) { - console.error(err); -} -``` -型とJSDoc見ればわかります。トークンはなくても`serverinfo-api`や`token/get`は動きますが大体の事例では入れると思います。`uwuzu().token`の`set`は検証を行うわけではありませんが64文字でない、空文字列であるなどの場合はエラーが発生します。 - -## APIリクエスト -```ts -import uwuzu from "better-uwuzu-sdk"; -import type ApiMap from "better-uwuzu-sdk/1.6.11/map"; - -const client = new uwuzu({ - 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); -} -``` +# Better uwuzu SDK +[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 + +# yarn +yarn add git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.0 + +# pnpm +pnpm add git+https://gitea.last2014.com/last2014/better-uwuzu-sdk.git#1.0.0 +``` +> **NOTE** +> このSDKはnpmリポジトリがありません。Gitリポジトリを使用しています。 + +> **WARNING** +> `#main`でのインストールもできますが破壊的変更の際に面倒だと思います。サポートしません。 + +## 初期化 +```ts +import uwuzu from "better-uwuzu-sdk"; +import type ApiMap from "better-uwuzu-sdk/1.6.11/map"; + +const client = new uwuzu({ + origin: "https://uwuzu.net", +}); + +try { + client.token = "APITOKEN"; +} catch (err) { + console.error(err); +} +``` +型とJSDoc見ればわかります。トークンはなくても`serverinfo-api`や`token/get`は動きますが大体の事例では入れると思います。`uwuzu().token`の`set`は検証を行うわけではありませんが64文字でない、空文字列であるなどの場合はエラーが発生します。 + +## APIリクエスト +```ts +import uwuzu from "better-uwuzu-sdk"; +import type ApiMap from "better-uwuzu-sdk/1.6.11/map"; + +const client = new uwuzu({ + 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にトークンは自動入力されるので上記の例のように省略できます。 \ No newline at end of file