Skip to content

Commit 0b45602

Browse files
authored
Merge pull request #33 from powersync-ja/readme-patch
Update README.md
2 parents c94f686 + 007bd9b commit 0b45602

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Learn more about self-hosting PowerSync [here](https://docs.powersync.com/self-h
1010

1111
This repository contains basic demonstrations in the `demos` folder.
1212

13-
- [NodeJS (Postgres)](./demos/nodejs/README.md)
13+
- [Node.js (Postgres)](./demos/nodejs/README.md)
1414

1515
- This can be started from the repo root with `docker compose -f demos/nodejs/docker-compose.yaml up`
1616

17-
- [NodeJS (MongoDB)](./demos/nodejs-mongodb/README.md)
17+
- [Node.js (MongoDB)](./demos/nodejs-mongodb/README.md)
1818

1919
- This can be started from the repo root with `docker compose -f demos/nodejs-mongodb/docker-compose.yaml up`
2020

@@ -36,13 +36,15 @@ Edit the demo `.env` files and config files in the `./config` directory with you
3636

3737
Populate the `replication->connections` entry with your database connection details.
3838

39-
A simple Postgres server is provided in the `ps-postgres.yaml` Docker compose file. Be sure to keep the credentials in `powersync.yaml` in sync with the config in `ps-postgres.yaml` if using this server.
39+
- **Postgres:** A simple Postgres server is provided in the `ps-postgres.yaml` Docker Compose file. Be sure to keep the credentials in `powersync.yaml` in sync with the config in `ps-postgres.yaml` if using this server.
4040

41-
See the `nodejs-mongodb` demo for MongoDB connection configuration.
41+
- **MongoDB:** See the [`nodejs-mongodb` demo](./demos/nodejs-mongodb/) for MongoDB connection configuration.
4242

4343
### Storage
4444

45-
The PowerSync Service uses MongoDB under the hood. A basic MongoDB replica-set service is available in `ps-mongo.yaml`. The `powersync.yaml` config is configured to use this service by default. Different MongoDB servers can be configured by removing the `include` statement from `docker-compose.yaml` and updating `powersync.yaml`.
45+
The [PowerSync Service](https://github.com/powersync-ja/powersync-service) uses MongoDB under the hood to store sync bucket state and operation history, regardless of whether you are syncing with a Postgres or MongoDB backend source database.
46+
47+
A basic MongoDB replica-set service is available in `ps-mongo.yaml`. The `powersync.yaml` config is configured to use this service by default. Different MongoDB servers can be configured by removing the `include` statement from `docker-compose.yaml` and updating `powersync.yaml`.
4648

4749
### Authentication
4850

0 commit comments

Comments
 (0)