serverpod-offline-sync/README.md

# Serverpod Offline Sync

[![GitHub](https://img.shields.io/badge/GitHub-marcelomendoncasoares-181717.svg?style=flat&logo=github)](https://github.com/marcelomendoncasoares)
[![Pub Package](https://img.shields.io/pub/v/serverpod_offline_sync.svg)](https://pub.dev/packages/serverpod_offline_sync)
[![Dart SDK Version](https://badgen.net/pub/sdk-version/serverpod_offline_sync.svg)](https://pub.dev/packages/serverpod_offline_sync)
[![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](https://github.com/marcelomendoncasoares/serverpod_offline_sync/blob/main/LICENSE)
[![CI](https://github.com/marcelomendoncasoares/serverpod_offline_sync/actions/workflows/ci.yaml/badge.svg?branch=main)](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.