summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2017-02-01 20:52:08 -0500
committerstreetturtle <streetturtle@gmail.com>2017-02-01 20:52:08 -0500
commita333acf17e0fc21104799daee8ea3ed7cb3f833f (patch)
tree5189281a7c46f891070633375b8fad2a13cd0c2b /README.md
parenta1fe01e1ad194b05319b00c96ebdc4d059652392 (diff)
Battery widget readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index aa2e212..dc9c91e 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
# AwesomeWM
-Set of simple widgets compatible with Awesome Window Manager v.4.
+Set of super simple widgets compatible with Awesome Window Manager v.4.
-Coming soon
+![screenshot](https://github.com/streetturtle/AwesomeWM/blob/master/screenshot.png?raw=true)
+
+Consists of:
- [battery-widget](https://github.com/streetturtle/AwesomeWM/tree/master/battery-widget)
- [brightness-widget](https://github.com/streetturtle/AwesomeWM/tree/master/brightness-widget)
@@ -10,3 +12,10 @@ Coming soon
- [rhythmbox-widget](https://github.com/streetturtle/AwesomeWM/tree/master/rhythmbox-widget)
- [spotify-widget](https://github.com/streetturtle/AwesomeWM/tree/master/spotify-widget)
- [volume-widget](https://github.com/streetturtle/AwesomeWM/tree/master/volume-widget)
+
+These widgets use [Arc icon theme](https://github.com/horst3180/arc-icon-theme) by default but it could be easily changed to any other icon theme.
+
+# Installation
+
+[Install](https://github.com/horst3180/arc-icon-theme#installation) Arc icon theme.
+Follow installation instruction of each widget: