Skip to content

Commit

Permalink
Merge pull request #14 from joegreen88/master
Browse files Browse the repository at this point in the history
Update README with instructions for the new options
  • Loading branch information
joegreen88 committed Jan 16, 2016
2 parents f688e6f + 85ea146 commit 816c852
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,21 @@ from the current version.
If this is the first run on the given environment, then a table called `db_config` is created and used to store the
current database version.

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
schema.
#### `--no-schema`
Use this flag to skip the schema files. This can be useful if you use an ORM to build the database schema.

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

#### `--install-provisional-version`
Use this flag to install a provisional version. This allows you to test out your database version, which may currently
be in development, before you commit to it by giving it a version number. This command looks for your provisional
version in `<project_root>/db/versions/new` by default.

#### `--provisional-version`
Use this option to provide a custom path to your provisional version. Your custom path is relative to the versions path.

### teardown
Run `vendor/bin/teardown <environment>` to tear down the tables on the given environment.

Expand Down

0 comments on commit 816c852

Please sign in to comment.