Skip to content

Commit e041f7b

Browse files
committed
update README
Signed-off-by: ふぁ <yuki@yuki0311.com>
1 parent 98f6abd commit e041f7b

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Table of Contents
44

5+
This repository contains two packages.
6+
57
- [twitter-openapi-typescript](./twitter-openapi-typescript) Package for human-friendly TypeScript
68
- [twitter-openapi-typescript-generated](./twitter-openapi-typescript-generated) TypeScript package automatically generated from [twitter-openapi](https://github.com/fa0311/twitter-openapi) by OpenAPI generator
79

@@ -11,15 +13,19 @@ graph LR
1113
B--Simplified handling-->C[twitter-openapi-typescript]
1214
```
1315

16+
---
17+
1418
## twitter-openapi-typescript
1519

20+
Learn more about people-friendly TypeScript packages here.
21+
1622
[twitter-openapi-typescript/README.md](./twitter-openapi-typescript/README.md)
1723

1824
## twitter-openapi-typescript-generated
1925

2026
> Note! twitter-openapi-typescript-generated is a package for advanced users who are familiar with Twitter's API. In general, [twitter-openapi-typescript](./twitter-openapi-typescript) should be used!
2127
22-
### Build
28+
Build
2329

2430
```shell
2531
git clone https://github.com/fa0311/twitter-openapi-typescript.git
@@ -35,7 +41,7 @@ java -jar tools/openapi-generator-cli.jar generate -g typescript-fetch -c tools/
3541
npm run build
3642
```
3743

38-
### Setup
44+
Setup
3945

4046
It cannot be installed from npm.
4147
Plan to release it in v1.0.0 with npm.
@@ -45,6 +51,6 @@ git clone https://github.com/fa0311/twitter-openapi-typescript
4551
npm install ./twitter-openapi-typescript/twitter-openapi-typescript
4652
```
4753

48-
### Usage
54+
Usage
4955

5056
[twitter-openapi-typescript-generated/README.md](./twitter-openapi-typescript-generated/README.md)

0 commit comments

Comments
 (0)