diff --git a/README.md b/README.md index 3f06f9e..eb012a9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ Package traqoauth2 provides constants for using OAuth2 to access traQ. ## Usage +> [!WARNING] +> OAuth2 Authorization Code Flowに則ったClientを実装する前に、他のより簡単な方法で実装できないか検討してください。 +> - ログインユーザーの traQ ID (e.g. `@traP`) を取得したい場合 +> - [traPtitech/NeoShowcase](https://github.com/traPtitech/NeoShowcase) +> - [traPtitech/caddy-trap-auth](https://github.com/traPtitech/caddy-trap-auth) +> - [traPtitech/traefik-forward-auth](https://github.com/traPtitech/traefik-forward-auth) +> - ログインユーザーの識別情報を利用したい (e.g. GET /users/me, POST /channels/:channelID/messages) 場合 +> - [Bot](https://bot-console.trap.jp/docs/bot)のAccess Tokenを用いる +> - (実装予定) [OAuth2 Client Credential Flow](https://github.com/traPtitech/traQ/issues/2403) を用いる + Full example: [_example/](_example/) ```go