diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-03-24 11:27:25 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-24 11:27:25 +0100 |
| commit | a055930cf862c74159218d0acfd09b64f1e09ed5 (patch) | |
| tree | c2b2d13770137775ec90caeac68df60c348c5341 /plugins/lighthouse | |
| parent | 1a4052b0451121556fceca63ee96255cca0ca94c (diff) | |
| download | zsh-a055930cf862c74159218d0acfd09b64f1e09ed5.tar.gz zsh-a055930cf862c74159218d0acfd09b64f1e09ed5.tar.bz2 zsh-a055930cf862c74159218d0acfd09b64f1e09ed5.zip | |
Fix README
Diffstat (limited to 'plugins/lighthouse')
| -rw-r--r-- | plugins/lighthouse/README.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md index 0dd0003f1..0db29b4e5 100644 --- a/plugins/lighthouse/README.md +++ b/plugins/lighthouse/README.md @@ -1,6 +1,6 @@ # Lighthouse plugin -This plugin issue lighthouse tickets. +This plugin adds commands to manage [Lighthouse](https://lighthouseapp.com/). To use it, add `lighthouse` to the plugins array in your zshrc file: @@ -8,8 +8,19 @@ To use it, add `lighthouse` to the plugins array in your zshrc file: plugins=(... lighthouse) ``` -## Aliases +## Commands -| Alias | Command | Description | -|-------|----------------------------------------|------------------------------------------------------| -| lho | `open_lighthouse_ticket` | Opening lighthouse ticket |
\ No newline at end of file +* `open_lighthouse_ticket <issue>` (alias: `lho`): + + Opens the URL to the issue passed as an argument. To use it, add a `.lighthouse-url` + file in your directory with the URL to the individual project. + + Example: + ```zsh + $ cat .lighthouse-url + https://rails.lighthouseapp.com/projects/8994 + + $ lho 23 + Opening ticket #23 + # The browser goes to https://rails.lighthouseapp.com/projects/8994/tickets/23 + ``` |