stepwise-migrations 1.0.21 → 1.0.22

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 +15 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -9,6 +9,7 @@ Loosely based on flyway.
9
9
  ## Table of Contents
10
10
 
11
11
  - [Stepwise Migrations](#stepwise-migrations)
12
+ - [Installation](#installation)
12
13
  - [Instructions](#instructions)
13
14
  - [Usage](#usage)
14
15
  - [Examples](#examples)
@@ -20,6 +21,20 @@ Loosely based on flyway.
20
21
  - [Get Applied Script](#get-applied-script)
21
22
  - [Drop](#drop)
22
23
 
24
+ ## Installation
25
+
26
+ Once your Postgres DB is running, simply use `npx` to get started:
27
+
28
+ ```bash
29
+ mkdir ./your-migrations-directory
30
+ echo "create table first (id serial primary key, name text not null);" > ./your-migrations-directory/v1_first.sql
31
+
32
+ npx stepwise-migrations migrate \
33
+ --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \
34
+ --schema=myschema \
35
+ --path=./your-migrations-directory/
36
+ ```
37
+
23
38
  ## Instructions
24
39
 
25
40
  There are three types of migrations:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stepwise-migrations",
3
- "version": "1.0.21",
3
+ "version": "1.0.22",
4
4
  "description": "A JavaScript CLI tool for managing Raw SQL migrations in a Postgres database. Loosely based on flyway.",
5
5
  "main": "./dist/src/index.js",
6
6
  "scripts": {