51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
# Serverpod Offline Sync
|
|
|
|
[](https://github.com/marcelomendoncasoares)
|
|
[](https://pub.dev/packages/serverpod_offline_sync)
|
|
[](https://pub.dev/packages/serverpod_offline_sync)
|
|
[](https://github.com/marcelomendoncasoares/serverpod_offline_sync/blob/main/LICENSE)
|
|
[](https://github.com/marcelomendoncasoares/serverpod_offline_sync/actions/workflows/ci.yaml)
|
|
|
|
A plugin to build offline-first applications with Serverpod. 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 Serverpod's existing APIs.
|
|
|
|
- [Serverpod Offline Sync](#serverpod-offline-sync)
|
|
- [Features](#features)
|
|
- [Getting started](#getting-started)
|
|
- [Usage](#usage)
|
|
- [License](#license)
|
|
|
|
---
|
|
|
|
## 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.
|