Skip to content

Commit 9dcba42

Browse files
committed
doc: Added minimum documentation
1 parent aad1405 commit 9dcba42

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,23 @@
1010
$ yarn add @shelf/postgres-local --dev
1111
```
1212

13-
### 1. Start Postgres - TO BE DONE
13+
### 1. Start Postgres
1414

1515
```js
1616
import {start} from '@shelf/postgres-local';
1717

18-
await start({});
18+
await start({
19+
seedPath: "schema.sql",
20+
version: 14
21+
});
1922
```
2023

21-
### 2. Stop Postgres - TO BE DONE
24+
### 2. Stop Postgres
2225

2326
```js
2427
import {stop} from '@shelf/postgres-local';
2528

26-
stop();
29+
await stop(14);
2730
```
2831

2932
## Publish

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@shelf/postgres-local",
3-
"version": "1.0.0",
3+
"version": "0.1.0-alpha",
44
"description": "Run 14 version of Postgres locally",
55
"keywords": [
66
"postgres",

0 commit comments

Comments
 (0)