Skip to content

Commit

Permalink
Improve README (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonheecs committed Jan 1, 2019
1 parent 6c72550 commit 4219faf
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Expand Up @@ -9,11 +9,18 @@ A Heroku plugin that allows you to use vim in a dyno
## Usage
`heroku vim -a <app-name>`

This will install vim and start a bash session on the dyno
This will install vim on your dyno and start a bash shell with `vim` installed on your `$PATH`

You can then open any file in the dyno with vim like so:
```bash
vim /path/to/file
```

<br/>

You can set a command other than `bash` to be run as well:
#### Running another command instead of bash

You can set a command other than `bash` to be run:

`heroku vim -c 'rails console' -a <app-name>`

Expand All @@ -23,4 +30,4 @@ MIT
[coveralls-badge]: https://coveralls.io/repos/github/jasonheecs/heroku-vim/badge.svg?branch=master
[coveralls-link]: https://coveralls.io/github/jasonheecs/heroku-vim?branch=master
[travis-badge]: https://travis-ci.com/jasonheecs/heroku-vim.svg?branch=master
[travis-link]: https://travis-ci.com/jasonheecs/heroku-vim
[travis-link]: https://travis-ci.com/jasonheecs/heroku-vim

0 comments on commit 4219faf

Please sign in to comment.