Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
derimagia authored Nov 18, 2016
1 parent f24375d commit 43b76d5
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,27 @@ Refer to the [Terminus Wiki](https://github.com/pantheon-systems/terminus/wiki/P
**_Please download version 6.2.5 instead. Click on the `Looking for previous GA versions?` link to locate._**

## Examples:
`$ terminus site heidisql`

`$ terminus site heidi --site=my-company --env=dev`
Simply running the new site command "pancakes" or "pc" will auto-detect the application you have installed:

`$ terminus site sequelpro`
`$ terminus site pancakes`

`$ terminus site sequel --site=my-company --env=dev`
`$ terminus site pc`

`$ terminus site mysql-workbench`
`$ terminus site pc --site=my-site --env=dev`

`$ terminus site workbench --site=my-company --env=dev`
You can also be specific with the app you want if you have multiple installed:

`$ terminus site pc --app=sequel`

`$ terminus site pc --app=workbench`

`$ terminus site pc --app=heidi`

## Windows:
The plugin will automatically attempt to find the HeidiSQL executable within your `Program Files` directory. If your version of HeidiSQL is installed in a non-standard location or you are using the portable version of HeidiSQL, ensure the full path to heidisql.exe (including the executable itself) is set in the `TERMINUS_PANCAKES_HEIDISQL_LOC` environment variable.

Likewise, if your version of MySQL Workbench is installed outside the `Program Files` directory, make sure the `TERMINUS_PANCAKES_MYSQLWORKBENCH_LOC` environment variable is set.

## Help:
Run `terminus help site heidi|sequel|workbench` for help.
Run `terminus help site pancakes` for help.

0 comments on commit 43b76d5

Please sign in to comment.