This repository has been archived by the owner on Mar 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #151 from famedly/krille/mark-package-as-discontinued
build: bump version and mark package as discontinued
- Loading branch information
Showing
3 changed files
with
6 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 [email protected]:famedly/dart_openapi_codegen.git` | ||
1.2 `git clone [email protected]: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 | ||
> 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters