aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2020-03-11 09:42:35 +0100
committerCédric Bonhomme <cedric@cedricbonhomme.org>2020-03-11 09:42:35 +0100
commit1a8bc2b373faccc52c4cdd7fd88837096a93e3cd (patch)
tree88aa58226ba62406a1f29f4a87e81733ff65536e
parentFixed CSS menu class in article template. (diff)
downloadnewspipe-1a8bc2b373faccc52c4cdd7fd88837096a93e3cd.tar.gz
newspipe-1a8bc2b373faccc52c4cdd7fd88837096a93e3cd.tar.bz2
newspipe-1a8bc2b373faccc52c4cdd7fd88837096a93e3cd.zip
Updated README.
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index 39436933..069b8487 100644
--- a/README.md
+++ b/README.md
@@ -21,12 +21,12 @@ https://lists.sr.ht/~cedric/newspipe
## Main features
* multiple users can use a Newspipe instance;
-* an API to manage your feeds (you can connect your own crawler);
+* an API to manage feeds (you can connect your own crawler);
* data liberation: export and import your account with a JSON file;
* export and import feeds with OPML files;
* search and favorite articles;
* detection of inactive feeds;
-* share on Pinboard and reddit;
+* share articles on Pinboard, Reddit and Twitter;
* management of bookmarks (with import from Pinboard).
@@ -37,7 +37,7 @@ Newspipe is really easy to deploy.
### Requirements
```bash
-$ sudo apt-get install postgresql npm
+$ sudo apt-get install npm postgresql
```
## Configure and install the application
@@ -45,8 +45,8 @@ $ sudo apt-get install postgresql npm
```bash
$ git clone https://git.sr.ht/~cedric/newspipe
$ cd newspipe/
-$ poetry install
$ npm install
+$ poetry install
$ cp instance/production.py instance/development.py
$ poetry shell
$ python manager.py db_create
@@ -54,6 +54,14 @@ $ python runserver.py
* Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
```
+If you want to use SQLite you do not need to install PostgreSQL. Simply use
+the provided configuration file (in ``instance/sqlite.py``) thank to this
+environment variable:
+
+```bash
+export Newspipe_CONFIG=sqlite.py
+```
+
## License
[Newspipe](https://git.sr.ht/~cedric/newspipe) is under the
bgstack15