aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <kimble.mandel@gmail.com>2014-04-09 08:13:50 +0200
committerCédric Bonhomme <kimble.mandel@gmail.com>2014-04-09 08:13:50 +0200
commitfbedc2169fbb02312d5de8e33c59da2de2e28f1c (patch)
tree630f08b4e034715730d79412f389c91999ce4021
parentDetection if running on Heroku. (diff)
downloadnewspipe-fbedc2169fbb02312d5de8e33c59da2de2e28f1c.tar.gz
newspipe-fbedc2169fbb02312d5de8e33c59da2de2e28f1c.tar.bz2
newspipe-fbedc2169fbb02312d5de8e33c59da2de2e28f1c.zip
Updated README.
-rw-r--r--README.rst (renamed from README.md)38
1 files changed, 23 insertions, 15 deletions
diff --git a/README.md b/README.rst
index 856bd08d..d1553f86 100644
--- a/README.md
+++ b/README.rst
@@ -1,17 +1,17 @@
+++++++++++++
pyAggr3g470r
-============
-
-#### A simple Python news aggregator.
+++++++++++++
Presentation
-------------
-[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is a news aggregator with a web interface
-based on [Flask](http://flask.pocoo.org/).
+============
+
+`pyAggr3g470r <https://bitbucket.org/cedricbonhomme/pyaggr3g470r/>`_ is a news aggregator with a web interface
+based on `Flask <http://flask.pocoo.org/>`_.
Features
---------
+========
-* the database is managed with [SQLAlchemy](http://www.sqlalchemy.org/);
+* the database is managed with `SQLAlchemy <http://www.sqlalchemy.org/>`_;
* feeds batch import with OPML files;
* export all your feeds to OPML;
* e-mail notification;
@@ -20,6 +20,10 @@ Features
* share articles with Google +, Pinboard and reddit.
+Usage
+=====
+
+
Deployment
----------
@@ -85,15 +89,19 @@ For example if you want to check for updates every 30 minutes, add this line to
You must give the email address you use to login to pyAggr3g470r.
Donation
---------
-If you wish and if you like pyAggr3g470r, you can donate via bitcoin
-[1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ](https://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ).
+========
+
+If you wish and if you like *pyAggr3g470r*, you can donate via bitcoin
+`1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ <https://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ>`_.
Thank you!
License
--------
-[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is under [GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.
+=======
+
+`pyAggr3g470r <https://bitbucket.org/cedricbonhomme/pyaggr3g470r>`_
+is under the `GNU Affero General Public License version 3 <https://www.gnu.org/licenses/agpl-3.0.html>`_.
Contact
--------
-[My home page](http://cedricbonhomme.org/).
+=======
+
+`My home page <http://cedricbonhomme.org/>`_.
bgstack15