Skip to content

Commit 816c852

Browse files
committed
Merge pull request #14 from joegreen88/master
Update README with instructions for the new options
2 parents f688e6f + 85ea146 commit 816c852

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,21 @@ from the current version.
7878
If this is the first run on the given environment, then a table called `db_config` is created and used to store the
7979
current database version.
8080

81-
You can use the flag `--no-schema` to skip the schema files. This can be useful if you use an ORM to build the database
82-
schema.
81+
#### `--no-schema`
82+
Use this flag to skip the schema files. This can be useful if you use an ORM to build the database schema.
8383

84-
You can also use the option `--versions-path`, or `-p` for short, to provide a custom versions path.
84+
#### `--versions-path`
85+
Use this option, or `-p` for short, to provide a custom path to your versions.
8586
This allows you to override the default versions path which is `<project_root>/db/versions`.
8687

88+
#### `--install-provisional-version`
89+
Use this flag to install a provisional version. This allows you to test out your database version, which may currently
90+
be in development, before you commit to it by giving it a version number. This command looks for your provisional
91+
version in `<project_root>/db/versions/new` by default.
92+
93+
#### `--provisional-version`
94+
Use this option to provide a custom path to your provisional version. Your custom path is relative to the versions path.
95+
8796
### teardown
8897
Run `vendor/bin/teardown <environment>` to tear down the tables on the given environment.
8998

0 commit comments

Comments
 (0)