Merge branch 'readme-enhance-update' into 'master'
[Readme] Update See merge request famedly/famedlysdk!99
This commit is contained in:
commit
8bb35f7e88
14
README.md
14
README.md
|
@ -16,22 +16,11 @@ The API is documented here: [famedly.gitlab.io/famedlysdk](https://famedly.gitla
|
||||||
famedlysdk:
|
famedlysdk:
|
||||||
git:
|
git:
|
||||||
url: https://gitlab.com/famedly/famedlysdk.git
|
url: https://gitlab.com/famedly/famedlysdk.git
|
||||||
ref: 77be6102f6cbb2e01adc28f9caa3aa583f914235
|
|
||||||
```
|
|
||||||
|
|
||||||
(Optional) Import the store
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
famedlysdk_store_sqflite:
|
|
||||||
git:
|
|
||||||
url: https://gitlab.com/famedly/libraries/famedlysdk-store.git
|
|
||||||
ref: 17fbbed1ea9b04ca041e9479d4e74bb4d2c78d55
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```dart
|
```dart
|
||||||
import 'package:flutter/material.dart';
|
import 'package:flutter/material.dart';
|
||||||
import 'package:famedlysdk/famedlysdk.dart';
|
import 'package:famedlysdk/famedlysdk.dart';
|
||||||
import 'package:famedlysdk-store/ famedlysdk_store_sqflite.dart'; // Optional
|
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create a new client:
|
2. Create a new client:
|
||||||
|
@ -40,7 +29,8 @@ import 'package:famedlysdk-store/ famedlysdk_store_sqflite.dart'; // Optional
|
||||||
Client matrix = Client("HappyChat");
|
Client matrix = Client("HappyChat");
|
||||||
```
|
```
|
||||||
|
|
||||||
Or with store:
|
Take a look here for an example store:
|
||||||
|
https://gitlab.com/famedly/famedlysdk/snippets/1904187
|
||||||
|
|
||||||
```dart
|
```dart
|
||||||
Client matrix = Client("HappyChat", store: Store(this));
|
Client matrix = Client("HappyChat", store: Store(this));
|
||||||
|
|
Loading…
Reference in a new issue