Skip to content

Commit c68f16f

Browse files
committed
update readme
1 parent 999646c commit c68f16f

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed
Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
A library for Dart developers.
1+
# Official Flutter SDK for [Stream Activity Feeds](https://getstream.io/activity-feeds/)
22

3-
Created from templates made available by Stagehand under a BSD-style
4-
[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE).
3+
> The official Flutter components for Stream Activity Feeds
54
6-
## Usage
5+
**🔗 Quick Links**
76

8-
A simple usage example:
7+
- [Register](https://getstream.io/activity-feeds/try-for-free) to get an API key for Stream Activity Feeds
8+
- [Tutorial](https://getstream.io/activity-feeds/sdk/flutter/tutorial/) to learn how to setup a timeline feed, follow other feeds and post new activities.
9+
- [Stream Activity Feeds UI Kit](https://getstream.io/activity-feeds/ui-kit/) to jumpstart your design with notifications and social feeds
910

10-
```dart
11-
import 'package:stream_feed_flutter/stream_feed_flutter.dart';
11+
## 🛠 (WIP: expect breaking changes) Installation
1212

13-
main() {
14-
var awesome = new Awesome();
15-
}
16-
```
17-
18-
## Features and bugs
13+
#### Install as a git depedency
1914

20-
Please file feature requests and bugs at the [issue tracker][tracker].
15+
We are doing some polishing before releasing the UI kit, but if you want to have a sneak peek this is how. Next step is to add `stream_feed_flutter` to your dependencies, to do that just open pubspec.yaml and add it inside the dependencies section.
2116

22-
[tracker]: http://example.com/issues/replaceme
17+
```yaml
18+
dependencies:
19+
stream_feed_flutter:
20+
git:
21+
url: https://github.com/GetStream/stream-feed-flutter.git
22+
ref: master
23+
path: ./packages/stream_feed_flutter
24+
```

0 commit comments

Comments
 (0)