serverpod-offline-sync/README.md

48 lines
1.5 KiB
Markdown
Raw Normal View History

<!--
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
For information about how to write a good package README, see the guide for
[writing package pages](https://dart.dev/tools/pub/writing-package-pages).
For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-packages)
and the Flutter guide for
[developing packages and plugins](https://flutter.dev/to/develop-packages).
-->
A plugin to build offline-first applications with Drift. Develop your app as a
normal offline app and use this non-invasive plugin to automatically handle the
sync process using CRDT (Conflict-free Replicated Data Type). Works
out-of-the-box with Drift's existing APIs.
## Features
TODO: List what your package can do. Maybe include GIFs, or videos.
## Getting started
TODO: List prerequisites and provide or point to information on how to start
using the package.
## Usage
TODO: Include short and useful examples for package users. Add longer examples
to `/example` folder.
See the `/example` directory for a...
```dart
const like = 'sample';
```
<!-- ## Additional information
TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more. -->
## License
This package is distributed under the MIT License. See the LICENSE file for
more information.