aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <kimble.mandel@gmail.com>2013-11-10 00:54:36 +0100
committerCédric Bonhomme <kimble.mandel@gmail.com>2013-11-10 00:54:36 +0100
commit9300f8914755a7beb1dd969a32788767d089a222 (patch)
tree6dbfe7a46d39d21da4a35e4504d71be0f2ec668b
parentAdded initialization script. (diff)
downloadnewspipe-9300f8914755a7beb1dd969a32788767d089a222.tar.gz
newspipe-9300f8914755a7beb1dd969a32788767d089a222.tar.bz2
newspipe-9300f8914755a7beb1dd969a32788767d089a222.zip
Updated README.
-rw-r--r--README.md16
1 files changed, 5 insertions, 11 deletions
diff --git a/README.md b/README.md
index 99a12062..dd5069f1 100644
--- a/README.md
+++ b/README.md
@@ -3,23 +3,16 @@ 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/). Articles are stored in a [MongoDB](http://api.mongodb.org/python/current/) base.
-
Features
------------
* articles are stored in a [MongoDB](http://www.mongodb.org/) database (local or remote);
-* HTTP proxy support;
-* fast full-text indexing and searching thanks the [Whoosh](https://bitbucket.org/mchaput/whoosh) library;
-* e-mail notification;
-* export articles to HTML, raw text;
* favorite articles;
-* share articles with Google +, Pinboard, Identi.ca, Digg and reddit.
-
+* share articles with Google +, Pinboard and reddit.
Requierements
-------------
@@ -28,6 +21,10 @@ Python >= 2.7. To install the required libraries:
$ sudo pip install --upgrade -r requirements.txt
+Installation
+------------
+
+You can use the script initialization.py to create your user.
Backup
------
@@ -38,18 +35,15 @@ If you want to backup your database:
$ /etc/init.d/mongodb stop
$ cp /var/lib/mongodb/pyaggr3g470r.* ~
-
Donation
--------
If you wish and if you like pyAggr3g470r, you can donate via bitcoin 1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ.
Thank you!
-
License
-------
[pyAggr3g470r](https://bitbucket.org/cedricbonhomme/pyaggr3g470r/) is under [GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.
-
Contact
-------
[My home page](http://cedricbonhomme.org/).
bgstack15