inex
/
famedlysdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'readme-refactor-update' into 'master' 

[Readme] update

See merge request famedly/famedlysdk!147
This commit is contained in:
Christian Pauly 2020-01-04 10:25:30 +00:00
parent d8f43e6858 fe52bad5bc
commit cc360f2bc2
1 changed files with 3 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -6,7 +6,7 @@ Matrix SDK for the famedly talk app written in dart.
## API
The API is documented here: [famedly.gitlab.io/famedlysdk](https://famedly.gitlab.io/famedlysdk/)
The API is documented here: [famedly.gitlab.io/famedlysdk/famedlysdk/famedlysdk-library.html](https://famedly.gitlab.io/famedlysdk/famedlysdk/famedlysdk-library.html)
## How to use this
@ -30,10 +30,10 @@ Client matrix = Client("HappyChat");
```
Take a look here for an example store:
https://gitlab.com/famedly/famedlysdk/snippets/1904187
[https://gitlab.com/ChristianPauly/fluffychat-flutter/snippets](https://gitlab.com/ChristianPauly/fluffychat-flutter/snippets)
```dart
Client matrix = Client("HappyChat", store: Store(this));
Client matrix = Client("HappyChat");
```
3. Connect to a Matrix Homeserver and listen to the streams:
@ -68,13 +68,3 @@ final resp = await matrix.jsonRequest(
}
);
```
## Development
### Regenerating JSON Classes
To regenerate the part files of JSON Classes you need to run this command:
```bash
flutter pub run build_runner build
```