docs(readme): update (#42)

Himenon · Apr 8, 2021 · 819f22f · 819f22f
1 parent c8285ca
commit 819f22f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -18,12 +18,14 @@ yarn add -D @himenon/openapi-typescript-code-generator
 
 ## DEMO
 
-- [DEMO](./example/README.md)
+- [Short DEMO](https://github.com/Himenon/openapi-typescript-code-generator-demo-project)
 - [DEMO: github/rest-api-client code generate](https://github.com/Himenon/github-rest-api-client/tree/master/source)
   - https://github.com/github/rest-api-description
 
 ## Usage
 
+The example shown here can be cloned from the [DEMO repository](https://github.com/Himenon/openapi-typescript-code-generator-demo-project) to see how it works.
+
 ### Generate typedef-only code
 
 ```ts
@@ -89,7 +91,7 @@ const main = () => {
   const apiClientCode = codeGenerator.generateCode([
     {
       generator: () => {
-        return [`import { Schemas } from "./types";`];
+        return [`import { Schemas, Responses } from "./types";`];
       },
     },
     codeGenerator.getAdditionalTypeDefinitionCustomCodeGenerator(),

diff --git a/docs/ja/README-ja.md b/docs/ja/README-ja.md
@@ -10,7 +10,7 @@ OpenAPI から抽出したパラメーターは自由に使うことができる
 
 ## DEMO
 
-- [DEMO](../example/README.md)
+- [Short DEMO](https://github.com/Himenon/openapi-typescript-code-generator-demo-project)
 - [DEMO: github/rest-api-client code generate](https://github.com/Himenon/github-rest-api-client/tree/master/source)
   - https://github.com/github/rest-api-description
 
@@ -22,6 +22,8 @@ yarn add -D @himenon/openapi-typescript-code-generator
 
 ## 使い方
 
+ここで記されている例は[DEMO用のリポジトリ](https://github.com/Himenon/openapi-typescript-code-generator-demo-project)をクローンして動作確認することができます。
+
 ### 型定義のみのコードを生成する
 
 ```ts
@@ -87,7 +89,7 @@ const main = () => {
   const apiClientCode = codeGenerator.generateCode([
     {
       generator: () => {
-        return [`import { Schemas } from "./types";`];
+        return [`import { Schemas, Responses } from "./types";`];
       },
     },
     codeGenerator.getAdditionalTypeDefinitionCustomCodeGenerator(),