summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 34 insertions, 5 deletions
diff --git a/README.md b/README.md
index b2a4747..1463056 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,37 @@
-# temp-postgres
+# Temp PostgreSQL
-The temp-postgres utility runs the PostgreSQL server off a temporary data directory.
-See [this](https://www.skreutz.com/posts/temporary-postgresql-server/) blog post for an introduction, and refer to the man page for details.
+The `temp-postgres` utility runs the PostgreSQL server off a temporary data
+directory. See [this][intro] blog post for an introduction.
-## Install
+[intro]: https://www.skreutz.com/posts/temporary-postgresql-server/
+
+## Usage
+
+Create a temporary database "test" with superuser "alex":
+
+ $ temp-postgres test alex
+
+Connect to the "test" database:
+
+ $ psql --host=localhost test alex
+
+See the manual page for details.
+
+## Dependencies
+
+The `temp-postgres` utility depends on `sh(1)` and `postgres(1)`.
+
+On OpenBSD you can install the dependencies using `pkg_add(1)`:
+
+ $ doas pkg_add postgresql-server postgresql-client
+
+On Void Linux you can install the dependencies using `xbps-install(1)`:
+
+ $ sudo xbps-install -S dash postgresql postgresql-client
+
+## Installation
+
+ $ ./configure
+ $ make
+ $ sudo make install
-Run `make install` as root to install the `temp-postgres` utility and man page.
Generated by cgit. See skreutz.com for my tech blog and contact information.