Skip to content

Commit 6e5db86

Browse files
committed
📝 Remove @plotdb references from docs and package name
We merged a fork back into this library. This change removes references to the fork.
1 parent 499702a commit 6e5db86

File tree

4 files changed

+13
-21
lines changed

4 files changed

+13
-21
lines changed

Diff for: CHANGELOG.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,9 @@
55

66
## 4.0.0
77

8-
- upgrade `pg` from 7.4.1 to 8.5.1 to prevent silent failure for node v14 or later, reported in [this issue](https://github.com/brianc/node-postgres/issues/2317).
8+
- upgrade `pg` from 7.4.1 to 8.5.1 to prevent silent failure for node v14 or later, reported in [this issue](https://github.com/brianc/node-postgres/issues/2317).
99
- fix submit ops failed due to version mismatched - https://github.com/share/sharedb-postgres/issues/8
1010

11-
## Note about re-versioning
12-
13-
Original `sharedb-postgres` seems to have been not maintained for a long time since 2018. Thus we made a fork and maintain it as `@plotdb/sharedb-postgre`.
14-
1511

1612
# Change log in original repo
1713

Diff for: README.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @plotdb/sharedb-postgres
1+
# sharedb-postgres
22

33
PostgreSQL database adapter for [sharedb](https://github.com/share/sharedb). This driver can be used both as a snapshot store and oplog.
44

@@ -7,15 +7,11 @@ Doesn't support queries (yet?).
77
Moderately experimental. (This drives [Synaptograph](https://www.synaptograph.com)'s backend, and [@nornagon](https://github.com/nornagon) hasn't noticed any issues so far.)
88

99

10-
## Note about versioning
1110

12-
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`.
13-
14-
15-
## Installation
11+
## Installation
1612

1713
```cmd
18-
npm i @plotdb/sharedb-postgres
14+
npm i sharedb-postgres
1915
```
2016

2117

@@ -25,7 +21,7 @@ Due to the fix to resolve [high concurency issues](https://github.com/share/shar
2521

2622
## Migrating older versions
2723

28-
Older versions of this adaptor used the data type json. You will need to alter the data type prior to using if you are upgrading.
24+
Older versions of this adaptor used the data type json. You will need to alter the data type prior to using if you are upgrading.
2925

3026
```PLpgSQL
3127
ALTER TABLE ops
@@ -44,16 +40,16 @@ ALTER TABLE snapshots
4440
`sharedb-postgres-jsonb` wraps native [node-postgres](https://github.com/brianc/node-postgres), and it supports the same configuration options.
4541

4642
To instantiate a sharedb-postgres wrapper, invoke the module and pass in your
47-
PostgreSQL configuration as an argument or use environmental arguments.
43+
PostgreSQL configuration as an argument or use environmental arguments.
4844

4945
For example using environmental arugments:
5046

5147
```js
52-
var db = require('@plotdb/sharedb-postgres')();
48+
var db = require('sharedb-postgres')();
5349
var backend = require('sharedb')({db: db})
5450
```
5551

56-
Then executing via the command line
52+
Then executing via the command line
5753

5854
```
5955
PGUSER=dbuser PGPASSWORD=secretpassword PGHOST=database.server.com PGDATABASE=mydb PGPORT=5433 npm start
@@ -62,7 +58,7 @@ PGUSER=dbuser PGPASSWORD=secretpassword PGHOST=database.server.com PGDATABASE=m
6258
Example using an object
6359

6460
```js
65-
var db = require('@plotdb/sharedb-postgres')({host: 'localhost', database: 'mydb'});
61+
var db = require('sharedb-postgres')({host: 'localhost', database: 'mydb'});
6662
var backend = require('sharedb')({db: db})
6763
```
6864

Diff for: package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@plotdb/sharedb-postgres",
2+
"name": "sharedb-postgres",
33
"version": "4.0.1",
44
"description": "PostgreSQL adapter for ShareDB. forked from share/sharedb-postgres",
55
"main": "index.js",
@@ -16,7 +16,7 @@
1616
],
1717
"repository": {
1818
"type": "git",
19-
"url": "https://github.com/plotdb/sharedb-postgres"
19+
"url": "https://github.com/share/sharedb-postgres"
2020
},
2121
"dependencies": {
2222
"pg": "^8.5.1",

0 commit comments

Comments
 (0)