updated license and README

README.md

@@ -1 +1,78 @@
-Cookies are saved in cookies.txt
+Introduction
+============
+
+pyferea is my solution to [this
+email](http://lists.debian.org/debian-user/2011/07/msg01362.html) that I posted
+to the debian-users list in 2011. I was fed up with there being no sane RSS
+reader in existance that could just render some RSS entries in a fast and
+simple fashion.
+
+Quick Start
+===========
+
+Create a feeds.yaml (you can copy feeds.yaml.example) and then run:
+
+$ python pyferea.py
+
+Naming
+======
+
+It is called pyferea (python feed reader) for now as I was inspired by the
+layout of liferea (linux feed reader). I guess I'm just too lazy to come up
+with another name but suggestions are welcome. Pyferea is just the first thing
+that sprang to my mind when I had to give the sourcecode directory a name and I
+didnt change it since.
+
+Purpose
+=======
+
+I might really overlook something out there but everytime I checked there was
+no sane RSS feed reader out there that would please me. I did not think that I
+would require much. Just three panes for feeds, entries and content, keeping
+record of unread entries and rendering content in a browser. Liferea came close
+but was poisoned by feature bloat (as many others... especially gnome
+dependencies) and major slowness. Pyferea does just what I want, is simple, DE
+agnostic (uses python and gtk) and fits in about 1000 lines of code.
+
+Bugs
+====
+
+Pyferea as it is now is enough for my daily use but there are still some issues
+that need to be fixed: the back/forward functionality of the browser must be
+fixed (i seldomly use it), the date/time in the entry panel doesnt update
+correctly over time (i can live with it for now) and the text in the
+addressbar, title and tabtitle must be synced. I will fix that once I feel like
+it. If anybody feels inclined to do so, then patches are welcome.
+
+Dependencies
+============
+
+feeds.yaml
+==========
+
+It is a yaml dictionary with rss/atom feeds as keys and subdictionaries as
+values. For each entry they store the category a feed is in and if the link
+given in a feed entry should be loaded instead of the feed text.
+
+Example:
+
+```yaml
+http://planet.debian.org/rss20.xml:
+  category: "IT news"
+  loadlink: False
+http://slashdot.org/slashdot.rss:
+  category: "IT news"
+  loadlink: True
+```
+
+Cookies
+=======
+
+Cookies are kept in cookies.txt and are automatically accepted
+
+ythtml5.js
+==========
+
+A javascript that I load upon each pageload to convert youtube videos into
+their html5 versions so that the webkit plugin can render them even withoutme
+having flash.

pyferea.py

@@ -1,4 +1,19 @@
 #!/usr/bin/env python
+#
+# Copyright (C) 2012 Johannes 'josch' Schauer <j.schauer@email.de>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #TODO
 # gettext