commit 7d3674c5f9158a9fdd1a8871ff4334c9c2854676
parent a1d3ab1f71accbe429a3e48d9169243c70473bf0
Author: Dominik Schmidt <das1993@hotmail.com>
Date: Tue, 30 Jun 2015 13:17:47 +0200
Added a minimal readme.
Diffstat:
1 file changed, 19 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+Facebook to RSS converter
+==============
+
+This program is designed to provide non-login RSS Feeds from Facebookpages,
+since they turned the official RSS Feeds off.
+
+Compiling
+--------------
+
+- Install a D Compiler and Phobos Runtime
+- Make sure to add ./kxml/source/ as an includepath.
+
+Usage
+--------------
+```shell
+./Fb2RSS https://facebook.com/<page_name>
+```
+This will write the Atom Feed to stdout, which can be piped to a File, Process, /dev/null, whatever...
+