summaryrefslogtreecommitdiff
path: root/net-speed-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2021-04-21 10:46:44 -0400
committerGitHub <noreply@github.com>2021-04-21 10:46:44 -0400
commit323e032c3b59bea7654849071ef074289213a49b (patch)
tree8b8277d0c48480f31f328186b4708ee12b2a3bf2 /net-speed-widget
parent270665bca361a00fff746be6031d36b17b357aec (diff)
parentafa1c1af4984f2674b0e7ab421f082057db7f3ab (diff)
Merge pull request #252 from arjunadeltoso/patch-1
Some more READMEs installation instructions
Diffstat (limited to 'net-speed-widget')
-rw-r--r--net-speed-widget/README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/net-speed-widget/README.md b/net-speed-widget/README.md
index 1cac674..a09893e 100644
--- a/net-speed-widget/README.md
+++ b/net-speed-widget/README.md
@@ -1,3 +1,22 @@
# Net Speed Widget
-The widget and readme is in progress \ No newline at end of file
+The widget and readme is in progress
+
+## Installation
+
+Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo.
+
+Clone repo, include widget and use it in **rc.lua**:
+
+```lua
+local net_speed_widget = require("awesome-wm-widgets.net-speed-widget.net-speed")
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ net_speed_widget(),
+ ...
+ }
+ ...
+```