summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStefan Kreutz <mail@skreutz.com>2026-04-15 23:22:57 +0200
committerStefan Kreutz <mail@skreutz.com>2026-04-16 00:41:56 +0200
commitb1735044d222e7173447d6b72d6bc90085994d32 (patch)
tree52b8494020af10496f776b028b1894ad0fd9bfbd /README.md
parent2a7d8d3aa4b8b7e345cda70ea0a110bef775d132 (diff)
downloadtemp-postgres-b1735044d222e7173447d6b72d6bc90085994d32.tar.gz
Turn required arguments into optional flags
Thereby add minimal --help option. This is a breaking change of the command-line interface.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3b6051f..3663571 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,11 @@ This project's original source code is hosted [here][home].
Create a temporary database "test" with superuser "alex":
- $ temp-postgres test alex
+ $ temp-postgres --dbname test --username alex
Connect to the "test" database:
- $ psql --host=localhost test alex
+ $ psql --host localhost --dbname test --username alex
See the manual page for details.
@@ -48,5 +48,5 @@ On Arch Linux you can install the dependencies using `pacman(8)`:
Alternatively you can run (or install) the experimental Nix flake.
- $ nix run git+https://git.skreutz.com/temp-postgres.git -- <dbname> <username>
+ $ nix run git+https://git.skreutz.com/temp-postgres.git -- --help
Generated by cgit. See skreutz.com for my tech blog and contact information.