From a0d936354801a0ba4c03d840ec086251d4c461ac Mon Sep 17 00:00:00 2001
From: Andinus <andinus@inventati.org>
Date: Thu, 12 Mar 2020 02:59:04 +0530
Subject: Revert "Move README from org file to markdown"

This reverts commit 9db33380e4baadd725190c18f35810039c1c780e.
---
 README.org | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.org

(limited to 'README.org')

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..82b21ea
--- /dev/null
+++ b/README.org
@@ -0,0 +1,30 @@
+#+TITLE: Cetus
+
+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.
+*** 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.
-- 
cgit 1.4.1-2-gfad0