|
1 | | -<!-- |
2 | | -This README describes the package. If you publish this package to pub.dev, |
3 | | -this README's contents appear on the landing page for your package. |
| 1 | +<p align="center"> |
| 2 | + <a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a> |
| 3 | +</p> |
4 | 4 |
|
5 | | -For information about how to write a good package README, see the guide for |
6 | | -[writing package pages](https://dart.dev/guides/libraries/writing-package-pages). |
| 5 | +# PowerSync SDK for Dart/Flutter |
7 | 6 |
|
8 | | -For general information about developing packages, see the Dart guide for |
9 | | -[creating packages](https://dart.dev/guides/libraries/create-library-packages) |
10 | | -and the Flutter guide for |
11 | | -[developing packages and plugins](https://flutter.dev/developing-packages). |
12 | | ---> |
| 7 | +_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres or MongoDB on the server-side (MySQL coming soon)._ |
13 | 8 |
|
14 | | -TODO: Put a short description of the package here that helps potential users |
15 | | -know whether this package might be useful for them. |
| 9 | +This package (`powersync_core`) is the PowerSync client SDK for Dart. |
16 | 10 |
|
17 | | -## Features |
| 11 | +# Installation |
18 | 12 |
|
19 | | -TODO: List what your package can do. Maybe include images, gifs, or videos. |
20 | | - |
21 | | -## Getting started |
22 | | - |
23 | | -TODO: List prerequisites and provide or point to information on how to |
24 | | -start using the package. |
25 | | - |
26 | | -## Usage |
27 | | - |
28 | | -TODO: Include short and useful examples for package users. Add longer examples |
29 | | -to `/example` folder. |
30 | | - |
31 | | -```dart |
32 | | -const like = 'sample'; |
| 13 | +```bash |
| 14 | +dart pub add powersync_core |
33 | 15 | ``` |
34 | | - |
35 | | -## Additional information |
36 | | - |
37 | | -TODO: Tell users more about the package: where to find more information, how to |
38 | | -contribute to the package, how to file issues, what response they can expect |
39 | | -from the package authors, and more. |
0 commit comments