a055930cf862c74159218d0acfd09b64f1e09ed5

Author
Marc Cornellà <marc.cornella@live.com>
Committer
GitHub <noreply@github.com>
Date

Message

Fix README

Diff

 1diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md
 2index 0dd0003f1349f4f3cc913c94abda9df96423e7bb..0db29b4e582537082ff87db22f07470df8cf98fd 100644
 3--- a/plugins/lighthouse/README.md
 4+++ b/plugins/lighthouse/README.md
 5@@ -1,6 +1,6 @@
 6 # Lighthouse plugin
 7 
 8-This plugin issue lighthouse tickets.
 9+This plugin adds commands to manage [Lighthouse](https://lighthouseapp.com/).
10 
11 To use it, add `lighthouse` to the plugins array in your zshrc file:
12 
13@@ -8,8 +8,19 @@ To use it, add `lighthouse` to the plugins array in your zshrc file:
14 plugins=(... lighthouse)
15 ```
16 
17-## Aliases
18+## Commands
19 
20-| Alias | Command                                | Description                                          |
21-|-------|----------------------------------------|------------------------------------------------------|
22-| lho   | `open_lighthouse_ticket`               | Opening lighthouse ticket                            |
23+* `open_lighthouse_ticket <issue>` (alias: `lho`):
24+
25+  Opens the URL to the issue passed as an argument. To use it, add a `.lighthouse-url`
26+  file in your directory with the URL to the individual project.
27+
28+  Example:
29+  ```zsh
30+  $ cat .lighthouse-url
31+  https://rails.lighthouseapp.com/projects/8994
32+
33+  $ lho 23
34+  Opening ticket #23
35+  # The browser goes to https://rails.lighthouseapp.com/projects/8994/tickets/23
36+  ```