OfficialDakari
/
matrix-dart-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Clean up

This commit is contained in:
Christian Pauly 2020-12-30 12:46:02 +01:00
parent bb10adef79
commit af2024816f
3 changed files with 14 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,22 +1,21 @@
A library for Dart developers. # Matrix API Lite
Created from templates made available by Stagehand under a BSD-style This package is a dead simple data model over the client-server specification of https://matrix.org and is mostly used as a base for a more complete Matrix SDK.
[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE). It doesn't contain any logic and just provides methods for all API endpoints and json parser for all objects. It is intended to be as close to the specificaton
as possible so we get a 1:1 relationship with the API. More complex logic like a sync loop or a data model for rooms should be implemented in a more complete
Matrix SDK.
## Usage ## Usage
A simple usage example: A simple usage example:
```dart ```dart
import 'package:matrix_api_lite/matrix_api_lite.dart'; import 'package:matrix_api_lite/src/matrix_api.dart';
main() { void main() async {
var awesome = new Awesome(); final api = MatrixApi(homeserver: Uri.parse('https://matrix.org'));
final capabilities = await api.requestServerCapabilities();
print(capabilities.toJson());
} }
``` ```
## Features and bugs
Please file feature requests and bugs at the [issue tracker][tracker].
[tracker]: http://example.com/issues/replaceme

2
example/matrix_api_lite_example.dart
View File

@ -1,5 +1,3 @@
//import 'package:matrix_api_lite/matrix_api_lite.dart';
import 'package:matrix_api_lite/src/matrix_api.dart'; import 'package:matrix_api_lite/src/matrix_api.dart';
void main() async { void main() async {

6
pubspec.yaml
View File

@ -1,7 +1,7 @@
name: matrix_api_lite name: matrix_api_lite
description: A starting point for Dart libraries or applications. description: Dead simple data model for the matrix.org client-server API.
# version: 1.0.0 version: 0.1.0
# homepage: https://www.example.com homepage: https://famedly.com
environment: environment:
sdk: '>=2.10.0 <3.0.0' sdk: '>=2.10.0 <3.0.0'