diff --git a/README.md b/README.md index 1f9cb29..7ba6899 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,19 @@ -# Flutter Redux Starter +# Flutter Redux Starter/CRUD Generator We're using this approach to develop our [Flutter app](https://github.com/invoiceninja/flutter-mobile/) for [Invoice Ninja](https://www.invoiceninja.com). +## Usage + +- `git clone git@github.com:hillelcoren/flutter-redux-starter.git && cd ` +- `./starter.sh init ` +- `./starter.sh make ` + +For example: + +- `git clone git@github.com:hillelcoren/flutter-redux-starter.git posts && cd posts` +- `./starter.sh init acme posts jsonplaceholder.typicode.com` +- `./starter.sh make posts post title,body:textarea` + ## Features - Supports large Redux stores by persisting parts separately