added relevant readme

nrjdalal · Nov 1, 2023 · 2823c54 · 2823c54
1 parent 3373727
commit 2823c54
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,13 @@
-# To Be Added Soon
+# pglaunch - PostgreSQL Launcher
+
+## Usage
+
+```sh
+pglaunch
+# POSTGRES_URL=postgresql://postgres:12DX6l4rdSrS@localhost:5555/postgres
+
+pglaunch -p 5432
+# POSTGRES_URL=postgresql://postgres:@0kKYVqo9m0W@localhost:5432/postgres
+```
+
+Hint: Use flag `-n <project-name>` to easily identify the container in docker.