Skip to content

Commit 891b0d2

Browse files
author
abluchet
committed
Package name under @api-platform scope
1 parent 5726d15 commit 891b0d2

File tree

3 files changed

+18
-333
lines changed

3 files changed

+18
-333
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
11
# API Platform CRUD Generator
22

33
[![Build Status](https://travis-ci.org/api-platform/generate-crud.svg?branch=master)](https://travis-ci.org/api-platform/generate-crud)
4-
[![npm version](https://badge.fury.io/js/api-platform-generate-crud.svg)](https://badge.fury.io/js/api-platform-generate-crud)
4+
[![npm version](https://badge.fury.io/js/api-platform-generate-crud.svg)](https://badge.fury.io/js/@api-platform/generate-crud)
55
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
66

7-
[![NPM](https://nodei.co/npm/api-platform-generate-crud.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/api-platform-generate-crud/)
7+
[![NPM](https://nodei.co/npm/@api-platform/generate-crud.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/@api-platform/generate-crud/)
88

99
A generator to scaffold a React/Redux app with Create-Retrieve-Update-Delete features for any API exposing a Hydra documentation.
1010
Works especially well with APIs built with the [API Platform](https://api-platform.com) framework.
1111

12+
## Installation
13+
14+
```
15+
npm install -g @api-platform/generate-crud
16+
```
17+
18+
## Usage
19+
20+
```
21+
api-platform-generate-crud https://demo.api-platform.com/ output/ --resource Book
22+
```
23+
1224
## Features
1325

1426
* Generate high-quality ES6 components and files built with [React](https://facebook.github.io/react/), [Redux](http://redux.js.org), [React Router](https://reacttraining.com/react-router/) and [Redux Form](http://redux-form.com/) including:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "api-platform-generate-crud",
2+
"name": "@api-platform/generate-crud",
33
"version": "0.1.6",
44
"description": "Generate a CRUD application built with React, Redux and React Router from an Hydra-enabled API",
55
"files": [

0 commit comments

Comments
 (0)