aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2017-03-25 19:07:37 -0300
committerSilvio Rhatto <rhatto@riseup.net>2017-03-25 19:07:37 -0300
commit0c025d8c41eb3271b6fabda8c4dd6c8f3d2fa33d (patch)
tree91d6872607bceb2aa298721dd225b8d210171025
parentd6507677da00d8afaa3779664b1c06671e616c54 (diff)
downloadhttruta-0c025d8c41eb3271b6fabda8c4dd6c8f3d2fa33d.tar.gz
httruta-0c025d8c41eb3271b6fabda8c4dd6c8f3d2fa33d.tar.bz2
Updates README
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index f82d9f8..6b28e6a 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,27 @@ This is the engine behind the [Cache](https://cache.fluxo.info) feature used by
the [Semantic Scuttle](http://semanticscuttle.sourceforge.net/) instance known
as [Fluxo de Links](https://links.fluxo.info).
+Installation
+------------
+
+ git clone https://git.fluxo.info/httruta
+
+Dependencies
+------------
+
+Recommended:
+
+ sudo apt install httrack wkhtmltopdf
+
+Configuration
+-------------
+
+The default config is optimized for getting all new stuff added into [Fluxo de
+Links](https://links.fluxo.info).
+
+You might use httruta to archive any other website that has RSS support. To customize httruta,
+just copy the file `config.default` into `config` and edit to suit your needs.
+
Usage
-----