aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2014-06-18 18:46:16 +0200
committerCédric Bonhomme <cedric@cedricbonhomme.org>2014-06-18 18:46:16 +0200
commit170fe47d022a3bc30b47c0ff1277bee5034d25d5 (patch)
tree4f499428454d94d3ecef2e84d7472b4b4635c084
parentUpdated README. (diff)
downloadnewspipe-170fe47d022a3bc30b47c0ff1277bee5034d25d5.tar.gz
newspipe-170fe47d022a3bc30b47c0ff1277bee5034d25d5.tar.bz2
newspipe-170fe47d022a3bc30b47c0ff1277bee5034d25d5.zip
More informations about how to use the web service.
-rw-r--r--README.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index c440e0f8..263281d8 100644
--- a/README.rst
+++ b/README.rst
@@ -50,8 +50,8 @@ An instance of pyAggr3g470r is running `here <https://pyaggr3g470r.herokuapp.com
$ heroku ps:scale web=1
To enable account creation for users, you have to set some environment variables:
-
-.. code:: bash
+
+.. code:: bash
$ heroku config:set PLATFORM_URL=<URL-of-your-platform>
$ heroku config:set RECAPTCHA_PUBLIC_KEY=<your-recaptcha-public-key>
@@ -159,6 +159,14 @@ It is possible to get your articles *via* a dedicated Web service. See the examp
>>> rjson["result"][0]["date"]
u'Wed, 18 Jun 2014 14:25:18 GMT'
+Possible parameters:
+
+.. code:: bash
+
+ $ curl --user your-email:your-password "https://pyaggr3g470r.herokuapp.com/articles.json/?filter_=unread&feed=24"
+ $ curl --user your-email:your-password "https://pyaggr3g470r.herokuapp.com/articles.json/?filter_=read&feed=24&limit=20"
+ $ curl --user your-email:your-password "https://pyaggr3g470r.herokuapp.com/articles.json/?filter_=all&feed=24&limit=20"
+
Donation
========
@@ -167,11 +175,13 @@ If you wish and if you like *pyAggr3g470r*, you can donate via bitcoin
`1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ <https://blockexplorer.com/address/1GVmhR9fbBeEh7rP1qNq76jWArDdDQ3otZ>`_.
Thank you!
+
Internationalization
====================
pyAggr3g470r is translated into English and French.
+
License
=======
bgstack15