From 4a8438d7f2b7b16941240b91f39a9402c431ffc2 Mon Sep 17 00:00:00 2001 From: François Schmidts Date: Tue, 2 Feb 2016 23:30:57 +0100 Subject: writing a bit of doc, moving crawler together --- README.rst | 31 +++++++++++++------------------ 1 file changed, 13 insertions(+), 18 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index fbfda039..5d9733f8 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,14 @@ -++++ +==== JARR -++++ +==== Presentation -============ +------------ -`JARR (Just Another RSS Reader) `_ is a -web-based news aggregator. +`JARR (Just Another RSS Reader) `_ is a web-based news aggregator and reader. Main features -============= +------------- * can be easily deployed on Heroku or on a traditional server; * multiple users can use a JARR instance; @@ -21,37 +20,33 @@ Main features * detection of inactive feeds; * share articles with Google +, Pinboard and reddit. -The core technologies are `Flask `_, -`asyncio `_ and -`SQLAlchemy `_. +The core technologies are `Flask `_, `asyncio `_ and `SQLAlchemy `_. Python 3.5 is recommended. Documentation -============= +------------- A documentation is available `here `_ and provides different ways to install JARR. Internationalization -==================== +-------------------- JARR is translated into English and French. Donation -======== +-------- -If you wish and if you like *JARR*, you can donate via bitcoin -`1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ `_. +If you wish and if you like *JARR*, you can donate via bitcoin `1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ `_. Thank you! License -======= +------- -`JARR `_ -is under the `GNU Affero General Public License version 3 `_. +`JARR `_ is under the `GNU Affero General Public License version 3 `_. Contact -======= +------- `My home page `_. -- cgit