lighthouse: add README and clean up plugin (#7316)

2 files changed, 31 insertions, 9 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
+  ```
diff --git a/plugins/lighthouse/lighthouse.plugin.zsh b/plugins/lighthouse/lighthouse.plugin.zsh
index 4a47b6010..3fca2bf4f 100644
--- a/plugins/lighthouse/lighthouse.plugin.zsh
+++ b/plugins/lighthouse/lighthouse.plugin.zsh
@@ -1,16 +1,12 @@
-# To use: add a .lighthouse file into your directory with the URL to the
-# individual project. For example:
-# https://rails.lighthouseapp.com/projects/8994
-# Example usage: https://screencast.com/t/ZDgwNDUwNT
 open_lighthouse_ticket () {
   if [ ! -f .lighthouse-url ]; then
     echo "There is no .lighthouse-url file in the current directory..."
-    return 0;
-  else
-    lighthouse_url=$(cat .lighthouse-url);
-    echo "Opening ticket #$1";
-    open_command "$lighthouse_url/tickets/$1";
+    return 0
   fi
+
+  lighthouse_url=$(cat .lighthouse-url)
+  echo "Opening ticket #$1"
+  open_command "$lighthouse_url/tickets/$1"
 }
 
 alias lho='open_lighthouse_ticket'