diff options
| -rw-r--r-- | README.md | 71 | ||||
| -rw-r--r-- | README.rst | 83 |
2 files changed, 71 insertions, 83 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..4273f1fc --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ +# Newspipe + +## Presentation + +[Newspipe](https://gitlab.com/newspipe/newspipe) is a web-based news +aggregator and reader. + +## Main features + +* can be easily deployed on Heroku or on your server; +* multiple users can use a Newspipe 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; +* Pinboard and reddit; +* personal management of bookmarks (with import from Pinboard). + +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/). + + +## Documentation + +A documentation is available [here](https://newspipe.readthedocs.io) and +provides different ways to +[install Newspipe](https://newspipe.readthedocs.io/en/latest/deployment.html). + +Test Newspipe on Heroku: + +[](https://heroku.com/deploy?template=https://builds.sr.ht/~cedric/Stegano) + +It is important to specify an application name and the URL of your instance +(*PLATFORM_URL*) through the Heroku form. + + +## Contributions + +Contributions are welcome. If you want to contribute to Newspipe I highly +recommend you to install it in a Python virtual environment. For example: + + +```bash +$ sudo apt-get install postgresql npm +``` + +```bash +$ git clone https://gitlab.com/newspipe/newspipe.git +$ cd newspipe/ +$ pipenv install +✨🍰✨ +$ npm install +$ cp src/conf/conf.cfg-sample src/conf/conf.cfg +$ pipenv shell +$ python src/manager.py db_create +$ python src/runserver.py + * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit) +``` + +## License + +[Newspipe](https://gitlab.com/newspipe/newspipe) 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) diff --git a/README.rst b/README.rst deleted file mode 100644 index f3e15789..00000000 --- a/README.rst +++ /dev/null @@ -1,83 +0,0 @@ -======== -Newspipe -======== - -Presentation ------------- - -`Newspipe <https://gitlab.com/newspipe/newspipe>`_ 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 Newspipe 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; -* Pinboard and reddit; -* personal management of bookmarks (with import from Pinboard). - -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.7.0 is required. - - -Documentation -------------- - -A documentation is available `here <https://newspipe.readthedocs.io>`_ and -provides different ways to -`install Newspipe <https://newspipe.readthedocs.io/en/latest/deployment.html>`_. - -Test Newspipe on Heroku: - -.. image:: https://www.herokucdn.com/deploy/button.png - :target: https://heroku.com/deploy?template=https://github.com/newspipe/newspipe.git - -It is important to specify an application name and the URL of your instance -(*PLATFORM_URL*) through the Heroku form. - - -Contributions -------------- - -Contributions are welcome. If you want to contribute to Newspipe I highly -recommend you to install it in a Python virtual environment. For example: - - -.. code-block:: bash - - sudo apt-get install postgresql npm - -.. code-block:: bash - - git clone https://gitlab.com/newspipe/newspipe.git - cd newspipe/ - pipenv install - ✨🍰✨ - npm install - cp src/conf/conf.cfg-sample src/conf/conf.cfg - pipenv shell - python src/manager.py db_create - python src/runserver.py - * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit) - - -License -------- - -`Newspipe <https://gitlab.com/newspipe/newspipe>`_ 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>`_ |