Merge branch 'master' of github.com:streetturtle/awesome-wm-widgets

1 files changed, 25 insertions, 0 deletions

diff --git a/run-shell/README.md b/run-shell/README.md
new file mode 100644
index 0000000..59cbb5e
--- /dev/null
+++ b/run-shell/README.md
@@ -0,0 +1,25 @@
+# Run Shell
+
+Run prompt which is put inside a widget:
+
+[Demo](https://imgur.com/ohjAuCQ.mp4)
+
+## Installation
+
+1. Clone this repo under **~/.config/awesome/**:
+
+    ```bash
+    git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
+    ```
+
+1. Require 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),
+