diff options
| author | Arjuna Del Toso <arjuna.deltoso@gmail.com> | 2021-04-13 14:18:52 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-13 14:18:52 -0700 |
| commit | 7ee95debb76a4a88864380913b48b52f8f397cab (patch) | |
| tree | 0125a412665456e3c443fd59c2baf234ba9fe406 | |
| parent | a17b55a3fbb61f9a082374aedb76a1e1fc1576c9 (diff) | |
Update README.md
Net-Speed-Widget readme
| -rw-r--r-- | net-speed-widget/README.md | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/net-speed-widget/README.md b/net-speed-widget/README.md index 1cac674..141e6f9 100644 --- a/net-speed-widget/README.md +++ b/net-speed-widget/README.md @@ -1,3 +1,20 @@ # Net Speed Widget -The widget and readme is in progress
\ No newline at end of file +## 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(), + ... + } + ... +``` |