Skip to content

Commit c297b07

Browse files
committed
Clean up some README language
1 parent e846ac4 commit c297b07

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,24 @@ go get -u github.com/fergusstrange/embedded-postgres
2929

3030
This library aims to require as little configuration as possible, favouring overridable defaults
3131

32-
| Configuration | Default Value |
33-
| -------------- | ------------------------------------------- |
34-
| Username | postgres |
35-
| Password | postgres |
36-
| Database | postgres |
37-
| Version | 12.1.0 |
38-
| RuntimePath | $USER_HOME/.embedded-postgres-go/extracted |
39-
| DataPath | empty, results in *RuntimePath*/data |
40-
| Port | 5432 |
41-
| StartTimeout | 15 Seconds |
42-
43-
The *RuntimePath* directory is erased and recreated on each start and therefor not
44-
suitable for persistent data. If a persistent data location is required, set
45-
*DataPath* to a directory outside of *RuntimePath*.
46-
If the *RuntimePath* directory is empty or already initialized but with an incompatible
47-
postgres version, it gets cleared and reinitialized.
32+
| Configuration | Default Value |
33+
| -------------- | ------------------------------------------- |
34+
| Username | postgres |
35+
| Password | postgres |
36+
| Database | postgres |
37+
| Version | 12.1.0 |
38+
| RuntimePath | $USER_HOME/.embedded-postgres-go/extracted |
39+
| DataPath | $USER_HOME/.embedded-postgres-go/extracted/data |
40+
| Port | 5432 |
41+
| StartTimeout | 15 Seconds |
42+
43+
The *RuntimePath* directory is erased and recreated at each `Start()` and therefore not
44+
suitable for persistent data.
45+
46+
If a persistent data location is required, set *DataPath* to a directory outside *RuntimePath*.
47+
48+
If the *RuntimePath* directory is empty or already initialized but with an incompatible postgres version,
49+
it will be removed and Postgres reinitialized.
4850

4951
A single Postgres instance can be created, started and stopped as follows
5052
```go

0 commit comments

Comments
 (0)