Skip to content

Commit

Permalink
docs: サポート状況についてREADMEで触れるように
Browse files Browse the repository at this point in the history
  • Loading branch information
yupix committed Mar 4, 2024
1 parent 4cdc1d8 commit 66dc7df
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 40 deletions.
18 changes: 3 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ git%2Bgh.neting.cc%2Fyupix%2FMiPAC.svg?type=shield"/></a>

## Overview

[日本語のREADMEもあります](./README_JP.md)
[日本語の README もあります](./README_JP.md)

This library is the Core of MiPA.

Expand All @@ -25,21 +25,9 @@ It absorbs API differences between versions, etc., which you don't have to worry
> If you are installing from GitHub for some reason, we recommend using the `shared` branch with the following command.
> `pip install git+https://github.com/yupix/Mi.py.git@shared`
## Supported Misskey
## Support Status

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 or later||
|[Misskey Official](https://github.com/misskey-dev/misskey)|v12||
|[Misskey Official](https://github.com/misskey-dev/misskey)|v11||
Support status can be found [here](. /compiler/datas/support_status.md). If the endpoint you want to use is not supported, you may create an Issue to get priority support.

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.

Expand Down
34 changes: 9 additions & 25 deletions README_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,24 @@ git%2Bgh.neting.cc%2Fyupix%2FMiPAC.svg?type=shield"/></a>

![Alt](https://repobeats.axiom.co/api/embed/b7734178610a63a16de4b789aa9b43d22686e390.svg "Repobeats analytics image")


## 概要

MiPAのCoreとなるライブラリです
MiPA の Core となるライブラリです

MiPACはMisskey v11, 12, 13をサポートしているApi Wrapperです
本来気にしないといけないバージョンごとのAPIの違い等を吸収してくれます
MiPAC は Misskey v11, 12, 13 をサポートしている Api Wrapper です
本来気にしないといけないバージョンごとの API の違い等を吸収してくれます

> 現在大規模な作業を行っています。詳細については[こちら](https://github.com/yupix/MiPAC/issues/94)を御覧ください。
> GitHubから何らかの理由でインストールする場合は以下のコマンドで `shared` ブランチを使用することをおすすめします。
> GitHub から何らかの理由でインストールする場合は以下のコマンドで `shared` ブランチを使用することをおすすめします。
> `pip install git+https://github.com/yupix/Mi.py.git@shared`
## サポートしているMisskey

記号の意味

|status|meaning|
|---|---|
||動作確認済み、優先的にサポート|
||動作確認無し、Issue等が来た場合はサポート|
|×|サポートされておらず、使用を想定していない|
## サポート状況

|name|version|supported|
|---|---|---|
|[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を送信してください。サポートを行う場合があります。
サポート状況は [こちら](./compiler/datas/support_status.md) からご覧いただけます。もし使いたいエンドポイントがサポートされていない場合は Issue を作成することで優先的にサポートを行える可能性があります。

## 使い方

MiPACにはPyPiと独自のリポジトリの2つがあります、PyPiは比較的安定してからのリリースになりますが、独自のリポジトリはコミットごとにビルドが行われ公開されるようになっています。
MiPAC には PyPi と独自のリポジトリの 2 つがあります、PyPi は比較的安定してからのリリースになりますが、独自のリポジトリはコミットごとにビルドが行われ公開されるようになっています。

お好きなほうをご利用いただけると幸いです。

Expand All @@ -57,7 +42,6 @@ pip install mipac
pip install --extra-index-url https://onedev.akarinext.org/yupix/mipac-sync/MiPAC/~pypi/simple/ mipac
```


```python
import asyncio

Expand All @@ -77,11 +61,11 @@ if __name__ == '__main__':

### 一部サーバー(インスタンス)のバージョンによっては正常に動作しない可能性があります

MiPACの特徴として、v11,v12,v13のバージョンごとに生じる変更点をなるべく気にしなくてよいように作成していますが、現状の最新版であるv13でもv13の中で削除されたり、増えたりした物があります。結果的に追従しきれていない箇所があることがあります。そのため、そのような物を見つけた場合は、使用しているサーバーのバージョンと使用できないエンドポイント名をIssueに送信してください
MiPAC の特徴として、v11,v12,v13 のバージョンごとに生じる変更点をなるべく気にしなくてよいように作成していますが、現状の最新版である v13 でも v13 の中で削除されたり、増えたりした物があります。結果的に追従しきれていない箇所があることがあります。そのため、そのような物を見つけた場合は、使用しているサーバーのバージョンと使用できないエンドポイント名を Issue に送信してください

### モデルを自分でインスタンス化することは想定されていません

MiPACのモデルでは多くの場合、キーワード引数に `client`を受け取り、それを用いて`api` プロパティを生成します。しかし、サポート途中の機能なのではそこが省かれ、リリース後にモデルのインスタンス化に必要な引数として `client` が追加されることがあります。また、他にもモデルの更新のために引数が変更される可能性があります。そのため、引数の変更に関することをCHANGELOG等で通知することはありません
MiPAC のモデルでは多くの場合、キーワード引数に `client`を受け取り、それを用いて`api` プロパティを生成します。しかし、サポート途中の機能なのではそこが省かれ、リリース後にモデルのインスタンス化に必要な引数として `client` が追加されることがあります。また、他にもモデルの更新のために引数が変更される可能性があります。そのため、引数の変更に関することを CHANGELOG 等で通知することはありません

## LICENSE

Expand Down

0 comments on commit 66dc7df

Please sign in to comment.