pgpm 0.2.2 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -5
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -13,29 +13,37 @@
13
13
  - 🐘 **Portable Postgres Development** — Rely on standard SQL migrations for a workflow that runs anywhere Postgres does.
14
14
  - 🚀 **Turnkey Module-First Workspaces** — `pgpm init` delivers a ready-to-code Postgres workspace with CI/CD, Docker, end-to-end testing, and modern TS tooling.
15
15
 
16
-
17
16
  ## 🚀 Quick Start
18
17
 
19
- ### Installation
18
+ ### Install & Setup
20
19
 
21
20
  ```bash
21
+ # Install pgpm globally
22
22
  npm install -g pgpm
23
+
24
+ # Start local Postgres (via Docker) and export env vars
25
+ pgpm docker start
26
+ eval "$(pgpm env)"
23
27
  ```
24
28
 
29
+ > **Tip:** Already running Postgres? Skip the Docker step and just export your PG* vars.
30
+
31
+ ---
32
+
25
33
  ### Create Your First Project
26
34
 
27
35
  ```bash
28
- # 1. Create workspace
36
+ # 1. Create a workspace
29
37
  pgpm init --workspace
30
38
  cd my-app
31
39
 
32
40
  # 2. Create your first module
33
41
  pgpm init
34
42
 
35
- # 3. Add some SQL migrations to sql/ directory
43
+ # 3. Add a database change
36
44
  pgpm add some_change
37
45
 
38
- # 4. Deploy to database
46
+ # 4. Deploy everything
39
47
  pgpm deploy --createdb
40
48
  ```
41
49
 
@@ -46,6 +54,12 @@ pgpm deploy --createdb
46
54
  - `pgpm init` - Initialize a new module
47
55
  - `pgpm init --workspace` - Initialize a new workspace
48
56
 
57
+ ### Development Setup
58
+
59
+ - `pgpm docker start` - Start PostgreSQL container (via Docker)
60
+ - `pgpm docker stop` - Stop PostgreSQL container
61
+ - `pgpm env` - Print PostgreSQL environment variables for shell export
62
+
49
63
  ### Database Operations
50
64
 
51
65
  - `pgpm deploy` - Deploy database changes and migrations
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pgpm",
3
- "version": "0.2.2",
3
+ "version": "0.2.4",
4
4
  "author": "Dan Lynch <pyramation@gmail.com>",
5
5
  "description": "PostgreSQL Package Manager - Database migration and package management CLI",
6
6
  "main": "index.js",
@@ -70,5 +70,5 @@
70
70
  "pg",
71
71
  "pgsql"
72
72
  ],
73
- "gitHead": "e1890f22bf61282f1cced2026a57b161f137753d"
73
+ "gitHead": "bc6476c6a5730970be08bb4127cbf79fe5965202"
74
74
  }