Skip to content

Commit af2ce3c

Browse files
committed
fix: README and online doc should be harmonized about module usage
1 parent e900635 commit af2ce3c

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ API Platform Client Generator is a generator to scaffold app with Create-Retriev
1111

1212
Works especially well with APIs built with the [API Platform](https://api-platform.com) framework.
1313

14-
## Installation
14+
## Documentation
1515

16-
yarn global add @api-platform/client-generator
16+
The documentation of API Platform's Client Generator can be browsed [on the official website](https://api-platform.com/docs/client-generator).
1717

1818
## Usage
1919

2020
**Hydra**
2121
```sh
22-
generate-api-platform-client https://demo.api-platform.com/ output/ --resource Book
22+
npx @api-platform/client-generator https://demo.api-platform.com/ output/ --resource Book
2323
```
2424

2525
**OpenAPI** (experimental)
2626
```sh
27-
generate-api-platform-client https://demo.api-platform.com/docs.json output/ --resource Book --format swagger
27+
npx @api-platform/client-generator https://demo.api-platform.com/docs.json output/ --resource Book --format swagger
2828
```
2929

3030
## Features
@@ -42,10 +42,6 @@ generate-api-platform-client https://demo.api-platform.com/docs.json output/ --r
4242
* The generated HTML code is accessible to people with disabilities ([ARIA](https://www.w3.org/WAI/intro/aria) support)
4343
* The Redux and the React Router configuration is also generated
4444

45-
## Documentation
46-
47-
The documentation of API Platform's Client Generator can be browsed [on the official website](https://api-platform.com/docs/client-generator).
48-
4945
## Credits
5046

5147
Created by [Kévin Dunglas](https://dunglas.fr). Sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop).

0 commit comments

Comments
 (0)