diff --git a/README.md b/README.md index 9ee49de..7457816 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# @plotdb/sharedb-postgres +# sharedb-postgres PostgreSQL database adapter for [sharedb](https://github.com/share/sharedb). This driver can be used both as a snapshot store and oplog. @@ -9,8 +9,13 @@ Moderately experimental. (This drives [Synaptograph](https://www.synaptograph.co ## Note about versioning -This is a fork from the [original `sharedb-postgres`](https://github.com/share/sharedb-postgres) and its relative forks (see [billwashere](https://github.com/billwashere/sharedb-postgres-jsonb), [zbryikt](https://github.com/zbryikt/sharedb-postgres-jsonb). It seems to have been not maintained for a long time since 2018, Thus we decide to fork it and maintain it as `@plotdb/sharedb-postgre`. +This is the official ShareDB Postgres adapter as of August 2023. +Other forks have been maintained in the past during times when this repsitory was not actively maintained, notably: + + * https://github.com/billwashere/sharedb-postgres-jsonb + * https://github.com/zbryikt/sharedb-postgres-jsonb + * https://github.com/plotdb/sharedb-postgres ## Installation @@ -41,7 +46,7 @@ ALTER TABLE snapshots ## Usage -`sharedb-postgres-jsonb` wraps native [node-postgres](https://github.com/brianc/node-postgres), and it supports the same configuration options. +This package wraps native [node-postgres](https://github.com/brianc/node-postgres), and it supports the same configuration options. To instantiate a sharedb-postgres wrapper, invoke the module and pass in your PostgreSQL configuration as an argument or use environmental arguments.