docs: update README.md

feat/add-sphinx-doc
yupix 11 months ago
parent e7350114dd
commit 10aba9867e
No known key found for this signature in database
GPG Key ID: 2FF705F5C56D9C06

@ -18,12 +18,26 @@ This library is the Core of MiPA.
MiPAC is an Api Wrapper that supports Misskey v11, 12, and 13.
It absorbs API differences between versions, etc., which you don't have to worry about originally.
> [!IMPORTANT]
> MiPAC's development policy will be changed. Please see [this discussion](https://github.com/yupix/MiPAC/discussions/90) for more information.
## Supported Misskey
Indicators of support
|status|meaning|
|---|---|
||Operation verified, priority support|
|△| confirmation of operation, add support for features as and when issues, etc. come in.|
|×|Not supported and not intended for use|
|name|version|supported|
|---|---|---|
|[Misskey Official](https://github.com/misskey-dev/misskey)|v13, v12, v11||
|[Ayuskey](https://github.com/teamblackcrystal/misskey)|v5, v6||
|[Misskey Official](https://github.com/misskey-dev/misskey)|v13 or later||
|[Misskey Official](https://github.com/misskey-dev/misskey)|v12|△|
|[Misskey Official](https://github.com/misskey-dev/misskey)|v11|△|
If you are using a non-official Fork and it is not working properly, please send us a link to your Fork repository and server in an Issue and we may be able to assist you.
## Usage

@ -16,12 +16,26 @@ MiPAのCoreとなるライブラリです。
MiPACはMisskey v11, 12, 13をサポートしているApi Wrapperです。
本来気にしないといけないバージョンごとのAPIの違い等を吸収してくれます。
> [!IMPORTANT]
> MiPACの開発方針が変更されます。詳しくは[こちらのディスカッション](https://github.com/yupix/MiPAC/discussions/90)をご覧ください。
## サポートしているMisskey
記号の意味
|status|meaning|
|---|---|
||動作確認済み、優先的にサポート|
|△|動作確認無し、Issue等が来た場合はサポート|
|×|サポートされておらず、使用を想定していない|
|name|version|supported|
|---|---|---|
|[Misskey Official](https://github.com/misskey-dev/misskey)|v13, v12, v11||
|[Ayuskey](https://github.com/teamblackcrystal/misskey)|v5, v6||
|[Misskey Official](https://github.com/misskey-dev/misskey)|v13 またはそれ以降||
|[Misskey Official](https://github.com/misskey-dev/misskey)|v12|△|
|[Misskey Official](https://github.com/misskey-dev/misskey)|v11|△|
もしあなたが公式リポジトリではなくForkのサーバーを使用していて、正常にMiPACの機能が動作しない場合はIssueにForkのリポジトリと対象のインスタンスURLを送信してください。サポートを行う場合があります。
## 使い方

Loading…
Cancel
Save