From 2f1644f7cbc1a090ceea89351611150e5451a4cf Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Mon, 4 Feb 2019 20:33:17 -0500
Subject: update readme

---
 run-shell/README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

(limited to 'run-shell')

diff --git a/run-shell/README.md b/run-shell/README.md
index 098de6f..ad409e2 100644
--- a/run-shell/README.md
+++ b/run-shell/README.md
@@ -2,4 +2,24 @@
 
 Blurs background and shows widget with run prompts:
 
-![screenshot](./screenshot.png)
\ No newline at end of file
+![screenshot](./screenshot.png)
+
+## Install
+
+1. Clone this repo under **~/.config/awesome/**:
+
+    ```bash
+    git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+    ```
+
+1. Require weather widget at the beginning of **rc.lua**:
+
+    ```lua
+    local run_shell = require("awesome-wm-widgets.run_shell.run_shell")
+    ```
+
+1. Use it (don't forget to comment out the default prompt):
+
+    ```lua
+    awful.key({modkey}, "r", function () run_shell.launch() end),
+    ```
\ No newline at end of file
-- 
cgit v1.2.3