diff --git a/README.md b/README.md index 1b0a69b6..c407e7d1 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,21 @@ -A library for Dart developers. +# Matrix API Lite -Created from templates made available by Stagehand under a BSD-style -[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE). +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. +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 A simple usage example: ```dart -import 'package:matrix_api_lite/matrix_api_lite.dart'; +import 'package:matrix_api_lite/src/matrix_api.dart'; -main() { - var awesome = new Awesome(); +void main() async { + 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 +``` \ No newline at end of file diff --git a/example/matrix_api_lite_example.dart b/example/matrix_api_lite_example.dart index c588cf51..0699acc4 100644 --- a/example/matrix_api_lite_example.dart +++ b/example/matrix_api_lite_example.dart @@ -1,5 +1,3 @@ -//import 'package:matrix_api_lite/matrix_api_lite.dart'; - import 'package:matrix_api_lite/src/matrix_api.dart'; void main() async { diff --git a/pubspec.yaml b/pubspec.yaml index f796df2b..603bd7ca 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,7 +1,7 @@ name: matrix_api_lite -description: A starting point for Dart libraries or applications. -# version: 1.0.0 -# homepage: https://www.example.com +description: Dead simple data model for the matrix.org client-server API. +version: 0.1.0 +homepage: https://famedly.com environment: sdk: '>=2.10.0 <3.0.0'