From 1a4052b0451121556fceca63ee96255cca0ca94c Mon Sep 17 00:00:00 2001 From: Pasan Date: Sat, 20 Oct 2018 08:55:19 +0530 Subject: Added README.md to lighthouse plugin --- plugins/lighthouse/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 plugins/lighthouse/README.md (limited to 'plugins/lighthouse/README.md') diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md new file mode 100644 index 000000000..0dd0003f1 --- /dev/null +++ b/plugins/lighthouse/README.md @@ -0,0 +1,15 @@ +# Lighthouse plugin + +This plugin issue lighthouse tickets. + +To use it, add `lighthouse` to the plugins array in your zshrc file: + +```zsh +plugins=(... lighthouse) +``` + +## Aliases + +| Alias | Command | Description | +|-------|----------------------------------------|------------------------------------------------------| +| lho | `open_lighthouse_ticket` | Opening lighthouse ticket | \ No newline at end of file -- cgit v1.2.3-70-g09d2 From a055930cf862c74159218d0acfd09b64f1e09ed5 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Sun, 24 Mar 2019 11:27:25 +0100 Subject: Fix README --- plugins/lighthouse/README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'plugins/lighthouse/README.md') 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 ` (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 + ``` -- cgit v1.2.3-70-g09d2