From f106e5c5dd4736c8e17e56beb962dda18e1499e8 Mon Sep 17 00:00:00 2001
From: Chris Pomeroy <chris.pomeroy@ercot.com>
Date: Thu, 14 Sep 2017 18:16:50 +0000
Subject: [PATCH] Added Readme

---
 README.md |   38 ++++++++++++++++++++++++++++++++++++++
 1 files changed, 38 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..375e791
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# aaxconvert
+
+For converting aax files from audible to mp3 format.
+
+## Installing / Getting started
+
+You will need to have ffmpeg, python 2.7 and an activation/encryption key from audible.
+```shell
+packagemanager install ffmpeg
+python aaxConvert.py --code <activationcode> <filename> 
+
+```
+
+This will create a mp3's from the aax file in the following path.
+```shell
+/<dpath>/<artist>/<title>
+```
+
+## Configuration
+
+*optional add a .authcode with the activation key from audible so it doesn't have to be typed in everytime 
+
+#### --code
+Type: `String`
+
+Activation Code from audible to decrypt files
+
+#### -s, --single 
+
+Use this option to create a single file. This is false by default
+
+#### -d, --dpath
+ 
+Use this to set the destination path. Otherwise I will use the current directory
+
+#### -v, --verbose
+
+Verbose stdout logging. mainly for debug

--
Gitblit v1.10.0