Skip to content

fix: README and online doc should be harmonized about module usage #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2019
Merged

fix: README and online doc should be harmonized about module usage #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,20 @@ API Platform Client Generator is a generator to scaffold app with Create-Retriev

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

## Installation
## Documentation

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

## Usage

**Hydra**
```sh
generate-api-platform-client https://demo.api-platform.com/ output/ --resource Book
npx @api-platform/client-generator https://demo.api-platform.com/ output/ --resource Book
```

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

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

## Documentation

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

## Credits

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