Merge remote-tracking branch 'orig/master'

1 files changed, 26 insertions, 0 deletions

diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md
new file mode 100644
index 000000000..0db29b4e5
--- /dev/null
+++ b/plugins/lighthouse/README.md
@@ -0,0 +1,26 @@
+# Lighthouse plugin
+
+This plugin adds commands to manage [Lighthouse](https://lighthouseapp.com/).
+
+To use it, add `lighthouse` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... lighthouse)
+```
+
+## Commands
+
+* `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
+  ```