From 423832f12590138a0e9a3b9e320404f5a33fcb33 Mon Sep 17 00:00:00 2001 From: Michael Murtaugh Date: Mon, 17 Oct 2016 13:06:56 +0200 Subject: [PATCH] synced README with reality --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 715c442..f55d8d9 100644 --- a/README.md +++ b/README.md @@ -16,22 +16,29 @@ Installation pip install python-dateutil html5lib python setup.py install -Padinfo file -------------- -All pad-specific settings are loaded from a file called "padinfo.json" -- by default etherdump looks in the current directory. Make a copy of padinfo.sample.json to start one. Make sure to check that the URL and port settings are correct, and to paste the correct apikey here! +Example +--------------- + mkdir mydump + cd myddump + etherdump init + +The program then interactively asks some questions: - cp padinfo.sample.json ~/yourfolder/padinfo.json - nano padinfo.json + Please type the URL of the etherpad: + http://automatist.local:9001/ + The APIKEY is the contents of the file APIKEY.txt in the etherpad folder + Please paste the APIKEY: + xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -And then for instance: +The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands. - etherdump list subcommands ---------- -* sync +* init +* pull * list * listauthors * gettext