diff --git a/CHANGELOG.md b/CHANGELOG.md index 11dfec7..349c099 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## [1.7.4] - 9th Jan 2023 +Mention new package in Readme. + ## [1.7.3] - 9th Jan 2023 Mark package as discontinued. diff --git a/README.md b/README.md index 3fa7bdb..dd28543 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,5 @@ # Deprecation Notice: -This package will soon be merged with the [Matrix Dart SDK](https://pub.dev/packages/matrix) and from there be available as a library, not a stand alone package anymore. We hope that this will save us some overhead when maintaining the code. If you rely on this package as stand alone and importing the whole Matrix Dart SDK just to use this library is not an option for you, please open an issue here: https://github.com/famedly/dart_matrix_api_lite/issues +**This package is no longer maintained. The code has been moved to [Matrix Dart SDK](https://pub.dev/packages/matrix)!** -# Matrix API Lite - -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/src/matrix_api.dart'; - -void main() async { - final api = MatrixApi(homeserver: Uri.parse('https://matrix.org')); - final capabilities = await api.requestServerCapabilities(); - print(capabilities.toJson()); -} - -``` - -## Generated code - -The files in `lib/src/generated` are generated by [dart_openapi_codegen](https://gitlab.com/famedly/company/frontend/dart_openapi_codegen/) -from [matrix-spec](https://github.com/matrix-org/matrix-spec/). - -To regenerate the code, follow these steps: - -1. Clone both repositories next to each other - 1.1 `git clone git@github.com:famedly/dart_openapi_codegen.git` - 1.2 `git clone git@github.com:famedly/dart_matrix_api_lite.git` -2. Execute the script in the dart_openapi_codegen directory: -```sh -cd dart_openapi_codegen -./scripts/matrix.sh ../dart_matrix_api_lite/lib/src/generated -cd .. -``` -3. Run the build_runner in the matrix_api_lite directory: -```sh -cd dart_matrix_api_lite -dart pub get -dart run build_runner build -``` -4. Check lints and tests and create a merge request \ No newline at end of file +> This package has been merged with the [Matrix Dart SDK](https://pub.dev/packages/matrix) and is now only available as a library, not a stand alone package anymore. We hope that this will save us some overhead when maintaining the code. \ No newline at end of file diff --git a/pubspec.yaml b/pubspec.yaml index 6f80e07..ef10622 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: matrix_api_lite description: Dead simple data model for the matrix.org client-server API. -version: 1.7.3 +version: 1.7.4 homepage: https://famedly.com repository: https://github.com/famedly/dart_matrix_api_lite issues: https://github.com/famedly/dart_matrix_api_lite/issues