From 45b8d0637a0669c3281fc0449b08a93ea0b7a809 Mon Sep 17 00:00:00 2001
From: Pacien TRAN-GIRARD
Date: Tue, 11 Aug 2015 01:37:11 +0200
Subject: First (working) version

---
 readme.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 readme.md

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..6360b69
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,45 @@
+A feed processor
+================
+
+`A feed processor` is a simple Python framework for RSS feeds processing, providing classes with overridable methods 
+for easy alteration.
+
+It includes `a feed parser`, which parses RSS[0.90:2.0], Atom[0.3:1.0] and CDF feeds into Python objects.
+
+
+Purposes
+--------
+
+`A feed processor` can be used to programmatically remove advertisements from RSS feeds for instance.
+
+Since it is written in Python, this framework can be embedded in a scriptable RSS reader or used to make short CGI 
+proxy scripts.
+
+
+Usage
+-----
+
+The file `example.py` contains an example of a custom feed processor which performs light modifications on a public RSS 
+feed.
+
+
+Dependencies
+------------
+
+`A feed processor` is written in Python 3 and depends on `PyRSS2Gen` and `feedparser`, which are both available as 
+pip and distros packages.
+
+
+License
+-------
+
+`A feed processor` is a free software distributed under the terms of the provided GNU Affero General Public License.
+
+
+TODO list
+---------
+
+- [x] add an example
+- [ ] add some documentation
+- [ ] make a pip package
+- [ ] make distros packages?
-- 
cgit v1.2.3