Skip to content

Commit

Permalink
Add Usage section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
uberhacker committed Apr 2, 2017
1 parent 5357c5b commit a173495
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@

Terminus plugin to mount [Pantheon](https://pantheon.io/) site environments.

## Usage:
```
terminus [site:]mount|[site:]u(n)mount site-name.env [--dir=<directory>]
```

By default, the site environment will be mounted in `/tmp/site-name.env`.

If you want to mount in a different directory, use the `--dir=<directory>` option.

Keep in mind, if you do mount in a different directory, you will also need to specify the same `--dir` option when unmounting.
Keep in mind, if you mount in a different directory, you will also need to specify the same `--dir` option when unmounting.

## Examples:
Mount the site environment awesome-site.dev.
Expand Down

0 comments on commit a173495

Please sign in to comment.