summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@inventati.org>2020-03-12 14:46:30 +0530
committerAndinus <andinus@inventati.org>2020-03-12 14:46:30 +0530
commit02a0ce81e845a103e875cbc7772b866d8491d700 (patch)
treec75a2d8e42a7ae60bab2db2decb0a4236b380d0f
parent08c68e60ea7c4661bbf9083629842d516caff1ee (diff)
downloadcetus-02a0ce81e845a103e875cbc7772b866d8491d700.tar.gz
Clarify readme
-rw-r--r--README.org16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.org b/README.org
index 4d8ee07..8543467 100644
--- a/README.org
+++ b/README.org
@@ -4,10 +4,14 @@ Cetus is a wallpaper tool written in Go. It can set wallpapers from various
 sources. Default behaviour is to set a random wallpaper.
 
 * Defaults
-| flag | var  | default                                   |
-|------+------+-------------------------------------------|
-| mode | mode | random (daily when random is unavailable) |
-| src  | src  | random                                    |
+| flag   | var    | default                                   |
+|--------+--------+-------------------------------------------|
+| mode   | mode   | random (daily when random is unavailable) |
+| src    | src    | random                                    |
+
+Currently only Unsplash Source random is supported for width, height
+| width  | width  | 1920 |
+| height | height | 1080 |
 ** Astronomy Picture of the Day
 | flag         | var        | default                             |
 |--------------+------------+-------------------------------------|
@@ -27,7 +31,7 @@ sources. Default behaviour is to set a random wallpaper.
 - [[https://feh.finalrewind.org/][feh]]
 * Features
 - Set Daily, Weekly or Random wallpaper
-
+- Supports multiple sources
 * Examples
 ** Daily wallpaper
 *** from Astronomy Picture of the Day
@@ -62,7 +66,7 @@ cetus -src=bpod # This is same as above
 #+END_SRC
 *** from Unsplash Source
 #+BEGIN_SRC sh
-cetus -src=unsplash -mode=random
+cetus -src=unsplash -mode=random -width 1920 -height 1080
 
 cetus -src=unsplash # This is same as above
 #+END_SRC