Skip to content

Commit af369ae

Browse files
authored
Merge pull request #57 from powersync-ja/readme-monorepo-structure
Update monorepo structure summary
2 parents 8686e3d + b403673 commit af369ae

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ _[PowerSync](https://www.powersync.com) is a Postgres-SQLite sync layer, which h
66

77
# PowerSync Service
88

9-
`powersync-service` is the monorepo for the core PowerSync service.
9+
`powersync-service` is the monorepo for the core [PowerSync service](https://docs.powersync.com/architecture/powersync-service).
1010

1111
The service can be started using the public Docker image. See the image [notes](./service/README.md)
1212

13-
## Monorepo Structure: Packages
13+
# Monorepo Structure:
14+
## Packages
1415

1516
- [packages/service-core](./packages/service-core/README.md)
1617

@@ -35,15 +36,29 @@ The service can be started using the public Docker image. See the image [notes](
3536
- [packages/types](./packages/types/README.md)
3637
- Type definitions for the PowerSync service
3738

38-
## Monorepo Structure: Libraries
39+
## Libraries
3940

4041
- [libs/lib-services](./libs/lib-services/README.md)
4142

4243
- A light-weight set of definitions and utilities for micro services
4344

4445
## Service
4546

46-
The PowerSync service code is located in the `service` folder. This project is used to build the `journeyapps/powersync-service` Docker image.
47+
- [service](./service/README.md)
48+
49+
Contains the PowerSync service code. This project is used to build the `journeyapps/powersync-service` Docker image.
50+
51+
## Docs
52+
53+
- [docs](./docs/README.md)
54+
55+
Technical documentation regarding the implementation of PowerSync.
56+
57+
## Test Client
58+
59+
- [test-client](./test-client/README.md)
60+
61+
Contains a minimal client demonstrating direct usage of the HTTP stream sync API. This can be used to test sync rules in contexts such as automated testing.
4762

4863
# Developing
4964

0 commit comments

Comments
 (0)