Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hillelcoren committed Jun 25, 2018
1 parent e436064 commit f6574d5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]:hillelcoren/flutter-redux-starter.git <application> && cd <application>`
- `./starter.sh init <company> <application> <url>`
- `./starter.sh make <application> <module> <fields>`

For example:

- `git clone [email protected]: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
Expand Down

0 comments on commit f6574d5

Please sign in to comment.