Skip to content

Commit b9ab55d

Browse files
authored
chore: README adjustments (#3)
1 parent dbcb531 commit b9ab55d

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ This server synchronizes your [Orb](https://www.withorb.com/) account to a Postg
1010

1111
## How it works
1212

13-
![How it works](./docs/sync-engine-how.png)
14-
1513
- Creates a new schema `orb` in a Postgres database, with tables & columns matching Orb.
1614
- Exposes a `/webhooks` endpoint that listens to any Orb webhooks.
1715
- Inserts/updates/deletes changes into the tables whenever there is a change to Orb.
@@ -22,6 +20,7 @@ This server synchronizes your [Orb](https://www.withorb.com/) account to a Postg
2220
- Backfill of data
2321
- Entities that are not supported through webhooks like plans and billable metrics
2422
- `orb-sync-lib` is not yet published as standalone npm package (could be used in serverless functions or anywhere else)
23+
- Database migration not handled automatically, need to run migrations from `db/migrations` manually for now
2524

2625
## Supported Webhooks
2726

0 commit comments

Comments
 (0)