From 99c36a7e6a71d5494daddbb65e35b51b96a7cb35 Mon Sep 17 00:00:00 2001
From: Joel Grunbaum <joelgrun@gmail.com>
Date: Sat, 05 Dec 2020 12:30:55 +0000
Subject: [PATCH] Added readme

---
 README.org |   16 ++++++++++++++++
 .gitignore |    1 +
 2 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/.gitignore b/.gitignore
index 5a71a94..f35fcf7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@
 !reddit-wallpaper-fetcher.conf
 !.gitignore
 !LICENSE
+!README.org
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..23ec7ad
--- /dev/null
+++ b/README.org
@@ -0,0 +1,16 @@
+#+TITLE:Reddit wallpaper fetcher
+
+* What is this?
+This is a simple shell script to pull the images from a set of subreddits, intended for use as a dynamic wallpaper.
+It is written in bash and uses curl, jq and imagemagick for its processing.
+Currently it downloads the images, names them and places them in a folder which should set the wallpaper.
+It can optionally add the title of the image to the image.
+It uses a simple, bash readable configuration file.
+
+* How to use
+Copy the default configuration file to ~/.config/reddit-wallpaper-fetcher.conf and alter the variables as need be.
+The list of subreddits is a bash list, so every entry needs to be in quotes and seperated by a space or newline.
+
+* TODOs
+- Interface with the window manager to set the wallpaper
+- Setup image scaling/resizing

--
Gitblit v1.10.0