|
@@ -7,10 +7,41 @@ request or found a bug, please file it at the [issue tracker][].
|
7
|
7
|
|
8
|
8
|
[issue tracker]: https://github.com/memspace/zefyr/issues
|
9
|
9
|
|
10
|
|
-> **Important:** Zefyr currently tracks latest development version of
|
11
|
|
-> Flutter (`master` branch) and may not work with Flutter beta channel
|
12
|
|
-> if there are breaking changes.
|
13
|
|
-
|
14
|
10
|
For documentation see [https://github.com/memspace/zefyr](https://github.com/memspace/zefyr).
|
15
|
11
|
|
16
|
12
|
![zefyr screenshot](https://github.com/memspace/zefyr/raw/master/packages/zefyr/zefyr.png)
|
|
13
|
+
|
|
14
|
+## Installation
|
|
15
|
+
|
|
16
|
+Official releases of Zefyr can be installed from Dart's Pub package repository.
|
|
17
|
+
|
|
18
|
+> Note that versions from Pub track stable channel of Flutter. If you are on master channel
|
|
19
|
+> check out instructions below in this document.
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+To install Zefyr from Pub add `zefyr` package as a dependency to your `pubspec.yaml`:
|
|
23
|
+
|
|
24
|
+```yaml
|
|
25
|
+dependencies:
|
|
26
|
+ zefyr: [latest_version]
|
|
27
|
+```
|
|
28
|
+
|
|
29
|
+And run `flutter packages get`.
|
|
30
|
+
|
|
31
|
+#### Installing version of Zefyr compatible with master channel of Flutter.
|
|
32
|
+
|
|
33
|
+You need to add git dependency to your pubspec.yaml that points to `flutter-master` branch:
|
|
34
|
+
|
|
35
|
+```yaml
|
|
36
|
+dependencies:
|
|
37
|
+ zefyr:
|
|
38
|
+ git:
|
|
39
|
+ url: https://github.com/memspace/zefyr.git
|
|
40
|
+ ref: flutter-master
|
|
41
|
+ path: packages/zefyr
|
|
42
|
+```
|
|
43
|
+
|
|
44
|
+And run `flutter packages get`.
|
|
45
|
+
|
|
46
|
+Continue to [https://github.com/memspace/zefyr/blob/master/doc/quick_start.md](documentation) to
|
|
47
|
+learn more about Zefyr and how to use it in your projects.
|