From 9caa3e6dbf68b80b914ddd74b173fcdae1f42810 Mon Sep 17 00:00:00 2001
From: geritol <gergo.tolnai@gmail.com>
Date: Sat, 30 Sep 2017 15:20:05 +0200
Subject: [PATCH] added docs

---
 utils/README.MD | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 utils/README.MD

diff --git a/utils/README.MD b/utils/README.MD
new file mode 100644
index 0000000..93a90c6
--- /dev/null
+++ b/utils/README.MD
@@ -0,0 +1,34 @@
+# Utils for Mind-Expanding-Books
+
+Simple command line interface to extend and order the Mind-Expanding-Books list.
+
+## Getting started
+
+### Setup
+1) Copy ```config-sample.py``` to ```config.py```
+
+```bash
+  cp config-sample.py config.py
+```
+2) Get a GoodReads API key [here](https://www.goodreads.com/api/keys)
+3) Copy your public key to the ```config.py``` file
+
+### Converting
+
+Run
+
+```bash
+  python3 housekeep.py --file_type='old'
+```
+
+The ``--file_type='old'`` flag is needed if the books are displayed in the old format (in a list). New format is the default (when the records are displayed in tables).
+
+This will convert to the new format and save it to ``README-new.md``.
+
+**Note!** the first conversion can take some time, we wait 1 second between each request to GoodReads to not abuse the API.
+After the first generation only missing records will be tried to be retrieved.
+
+Run to see the available arguments
+```bash
+  python3 housekeep.py --help
+```