From d1f1e5a1fc8241bbec45572a42b0872a4560acfc Mon Sep 17 00:00:00 2001
From: gauthiier <d@gauthiier.info>
Date: Fri, 10 Dec 2021 11:09:37 +0100
Subject: [PATCH] README info

---
 README.md | 40 +++++++++++-----------------------------
 1 file changed, 11 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 1c25a0e..234f7d2 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,25 @@
 pppadump
 =========
 
-Tool to help manage periodic publishing of [etherpads](http://etherpad.org/) to static files, preserving metadata.
+
+Bunch of scripts to extract documents from an [etherpad](http://etherpad.org/) instance and produce templated static files.
+
+Forked from [constant](https://constantvzw.org/site/)'s [active archives](http://activearchives.org/wiki/Main_Page) [etherdump](https://gitlab.constantvzw.org/aa/etherdump) mixed with logic devised for [varia](https://varia.zone)'s [etherpump](https://git.vvvvvvaria.org/varia/etherpump) project
 
 
-Requirements
+
+Requirements / dependencies
 -------------
-	* python3
+	* python3 / pip3
 	* html5lib
-	* requests (settext)
-	* python-dateutil, jinja2 (index subcommand)
+	* requests
+	* python-dateutil, 
+	* jinja2
 
 Installation
 -------------
 
-    pip install python-dateutil jinja2 html5lib
+    pip3 install python-dateutil jinja2 html5lib
     python setup.py install
 
 Usage
@@ -45,7 +50,6 @@ subcommands
 * init
 * pull
 * list
-
 * listauthors
 * gettext
 * settext
@@ -61,28 +65,6 @@ To get help on a subcommand:
 	pppadump revisionscount --help
 
 
-Cookbook
-========================
-
-Using pppadump to migrate from one etherpad instance to another
-------------------------------------------------------------------
-
-    mkdir instance1 && cd instance1
-    pppadump init
-    pppadump pull --html --meta
-
-    (cd ..)
-    mkdir instance2 && cd instance2
-    pppadump init
-    pppadump pushhtml --basepath ../instance1 ../instance1/p/*.meta.json
-
-NB: sethtml/pushhtml seems to only work on the server itself, ie using API url such as localhost:9001.
-
-NB: This command indescriminantly clobbers pads in instance2 with the HTML of the dumped versions from instance1.
-
-This technique can be used to "reset" the database of a pad by recreating pads (without their history or editor info/colors) in a fresh database.
-
-
 Magicwords
 =================
 Following the suggestions of sister project/friendly fork [etherpump](https://git.vvvvvvaria.org/varia/etherpump/), the magic word mechanism has been expanded (from the inital single hard coded \_\_NOPUBLISH__ value) to and generalized to allow a the use of text markers in the source text to control various options, including options for use in preprocessing and translation of markdown using pandoc.