summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org25
1 files changed, 20 insertions, 5 deletions
diff --git a/README.org b/README.org
index 9cfe979..82b21ea 100644
--- a/README.org
+++ b/README.org
@@ -2,14 +2,29 @@
 
 Cetus is a wallpaper setting tool written in Go. This is a work in-progress.
 
+* Dependency
+** [[https://feh.finalrewind.org/][feh]]
+Required to set the wallpaper.
+* Examples
+** Image of the Day
+*** Astronomy Picture of the Day
+#+BEGIN_SRC sh
+cetus -apod -apod-api=https://api.nasa.gov/planetary/apod \
+      -apod-api-key=DEMO_KEY
+#+END_SRC
+** Set given wallpaper
+#+BEGIN_SRC sh
+# Local image as wallpaper
+cetus -img-path=/path/to/img
+
+# Remote image as wallpaper
+cetus -img-path=http://127.0.0.1
+#+END_SRC
+
 * Features
 ** Supports various Image of the Day services
 There are several Image of the Day services on the web, cetus will pull the
 latest image & set it as wallpaper.
-*** TODO [[http://apod.nasa.gov/apod/astropix.html][Astronomy Picture of the Day]]
+*** DONE [[http://apod.nasa.gov/apod/astropix.html][Astronomy Picture of the Day]]
 ** DONE Set given wallpaper
 Takes a path as input & sets it as wallpaper.
-
-* Dependency
-** [[https://feh.finalrewind.org/][feh]]
-Required to set the wallpaper.