aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: f6ec78578ab0accc11f92c6846a9a0580f83ff72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
====
JARR
====

Presentation
------------

`JARR (Just Another RSS Reader) <https://github.com/JARR/JARR>`_
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;
* a RESTful API to manage your articles (or connect your own crawler);
* data liberation: export and import all your account with a JSON file;
* export and import feeds with OPML files;
* favorite articles;
* detection of inactive feeds;
* share articles with Google +, Pinboard and reddit.

The core technologies are `Flask <http://flask.pocoo.org>`_,
`asyncio <https://www.python.org/dev/peps/pep-3156/>`_ ,
`SQLAlchemy <http://www.sqlalchemy.org>`_
and `React <https://facebook.github.io/react/>`_.

Python 3.5 is required.

Documentation
-------------

A documentation is available `here <https://jarr.readthedocs.io>`_ and provides
different ways to install JARR.

License
-------

`JARR <https://github.com/JARR/JARR>`_ is under the
`GNU Affero General Public License version 3 <https://www.gnu.org/licenses/agpl-3.0.html>`_.

Contact
-------

`Cédric Bonhomme <https://www.cedricbonhomme.org>`_
bgstack15