michael/fluro
michael
/
fluro
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme

This commit is contained in:
Luke 2017-05-13 22:11:48 -07:00
parent d80bef62fd
commit a61cbc364b
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -3,6 +3,7 @@
The brightest, hippest, coolest router for Flutter.
[![Version]](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://pub.dartlang.org/packages/fluro)
[![Build Status](https://travis-ci.org/goposse/fluro.svg?branch=master)](https://travis-ci.org/goposse/fluro)
[![Coverage](https://codecov.io/gh/goposse/fluro/branch/master/graph/badge.svg)](https://codecov.io/gh/goposse/fluro)
@ -17,15 +18,19 @@ The brightest, hippest, coolest router for Flutter.
## Getting started
You should ensure that you add the router as a dependency in your flutter project.
Currently, you will need to add the git repo directly. A submitted pub package will be available **soon**.
To add the dependency directly:
```yaml
```yaml
dependencies:
fluro:
git: git://github.com/goposse/flutter-router.git
fluro: "^1.0.0"
```
You can also reference the git repo directly if you want:
```yaml
dependencies:
fluro:
git: git://github.com/goposse/fluro.git
```
You should then run `flutter packages upgrade` or update your packages in IntelliJ.
## Example Project