From 1da9d718d54873e5ee4d8929c98f78b68a5a2ae0 Mon Sep 17 00:00:00 2001 From: Conrad Hofmeyr Date: Wed, 25 Sep 2024 13:10:36 -0600 Subject: [PATCH] Readme updates to be backend database agnostic; a few other minor corrections --- .env.template | 2 +- DEVELOP.md | 4 ++-- README.md | 12 ++++++------ service/README.md | 2 +- test-client/README.md | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.env.template b/.env.template index c8f358588..a3c5fd5d0 100644 --- a/.env.template +++ b/.env.template @@ -1,3 +1,3 @@ # Connections for tests -MONGO_TEST_UR="mongodb://localhost:27017/powersync_test" +MONGO_TEST_URL="mongodb://localhost:27017/powersync_test" PG_TEST_URL="postgres://postgres:postgres@localhost:5432/powersync_test" \ No newline at end of file diff --git a/DEVELOP.md b/DEVELOP.md index 83b0cc8bb..23eb51d4d 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -20,7 +20,7 @@ pnpm build The PowerSync service requires Postgres and MongoDB server connections. These configuration details can be specified in a `powersync.yaml` (or JSON) configuration file. -See the [Self hosting demo](https://github.com/powersync-ja/self-host-demo) for demos of starting these services. +See the [self-hosting demo](https://github.com/powersync-ja/self-host-demo) for demos of starting these services. A quick method for running all required services with a handy backend and frontend is to run the following in a checked-out `self-host-demo` folder. @@ -65,7 +65,7 @@ Some tests for these packages require a connection to MongoDB and Postgres. Conn These can be set in a terminal/shell ```bash -export MONGO_TEST_UR="mongodb://localhost:27017/powersync_test" +export MONGO_TEST_URL="mongodb://localhost:27017/powersync_test" export PG_TEST_URL="postgres://postgres:postgres@localhost:5432/powersync_test" ``` diff --git a/README.md b/README.md index 303db1497..dd5f13b31 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@

-_[PowerSync](https://www.powersync.com) is a Postgres-SQLite sync engine, which helps developers to create local-first real-time reactive apps that work seamlessly both online and offline._ +*[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).* # PowerSync Service -`powersync-service` is the monorepo for the core [PowerSync service](https://docs.powersync.com/architecture/powersync-service). +`powersync-service` is the monorepo for the core [PowerSync Service](https://docs.powersync.com/architecture/powersync-service). The service can be started using the public Docker image. See the image [notes](./service/README.md) @@ -19,7 +19,7 @@ The service can be started using the public Docker image. See the image [notes]( - [packages/jpgwire](./packages/jpgwire/README.md) - - Customized version of [pgwire](https://www.npmjs.com/package/pgwire?activeTab=dependencies) + - Customized version of [pgwire](https://www.npmjs.com/package/pgwire?activeTab=dependencies) (used with Postgres) - [packages/jsonbig](./packages/jsonbig/README.md) @@ -33,8 +33,8 @@ The service can be started using the public Docker image. See the image [notes]( - Library containing logic for PowerSync sync rules -- [packages/types](./packages/types/README.md) - - Type definitions for the PowerSync service +- [packages/types](./packages/types/) + - Type definitions for the PowerSync Service ## Libraries @@ -46,7 +46,7 @@ The service can be started using the public Docker image. See the image [notes]( - [service](./service/README.md) -Contains the PowerSync service code. This project is used to build the `journeyapps/powersync-service` Docker image. +Contains the PowerSync Service code. This project is used to build the `journeyapps/powersync-service` Docker image. ## Docs diff --git a/service/README.md b/service/README.md index 7f1655179..b5af8acf2 100644 --- a/service/README.md +++ b/service/README.md @@ -2,7 +2,7 @@

-*[PowerSync](https://www.powersync.com) is a Postgres-SQLite sync engine, which helps developers to create local-first real-time reactive apps that work seamlessly both online and offline.* +*[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).* # Quick reference diff --git a/test-client/README.md b/test-client/README.md index 9e8964f04..aedad978f 100644 --- a/test-client/README.md +++ b/test-client/README.md @@ -1,6 +1,6 @@ # Test Client -This is a minimal client demonstrating direct usage of the HTTP stream sync api. +This is a minimal client demonstrating direct usage of the HTTP stream sync API. For a full implementation, see our client SDKs.