From a055930cf862c74159218d0acfd09b64f1e09ed5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= <marc.cornella@live.com> Date: Sun, 24 Mar 2019 11:27:25 +0100 Subject: [PATCH] Fix README --- plugins/lighthouse/README.md | 21 ++++++++++++++++----- 1 file 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 + ```