From f45f2c4514d69ab56f44873c3369524fe84288de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=B5=E3=81=81?= Date: Fri, 21 Apr 2023 21:44:45 +0900 Subject: [PATCH] update README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: ふぁ --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2c62394..4dc9013 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,19 @@ Twitter OpenAPI(Swagger) specification - [Dart](https://github.com/fa0311/twitter_openapi_dart) - [React Documents](https://github.com/fa0311/twitter-openapi-docs) +## Usage + +```shell +openapi-generator-cli generate -g -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/openapi-3.0.yaml -o ./generated +``` + +Note that the license also inherits to the output. + +## Contribute + +- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json) +- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file. + ## License [agpl-3.0](./LICENSE.txt)