From 6001d515479878d1c5e3ffd9f7f320c873fa6599 Mon Sep 17 00:00:00 2001
From: Billy Brawner <billybrawner@gmail.com>
Date: Tue, 13 Feb 2018 18:27:47 -0600
Subject: [PATCH] Add README

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..423129d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Feader Library
+
+This repo houses the library behind Feader. The idea behind the project is to separate the logic for retrieving, parsing, and storing RSS feed elements from the display, so that interface used to access the data can be independent from the logic, therefore allowing much easier cross-platform development. 
+
+## Configuring the Environment
+
+On Ubuntu, run the following:
+
+```
+sudo apt install cmake libcurl3-openssl-dev libxml2-dev libsqlite3-dev
+```
+
+## Building
+
+Clone the repo, then run the following:
+
+```
+mkdir build
+cd build
+cmake ..
+make
+./Feader https://wbrawner.com/feed.xml
+```
+
+## Todo:
+
+[ ] Write tests
+[ ] Write Android client
+[ ] Write Windows 10 client OR Java client
+[ ] Write GTK client (if not Java client)
+[ ] Write Mac client (if not Java client)
\ No newline at end of file