From 3957c44faa392f94b6302580c78de9ccca367fea Mon Sep 17 00:00:00 2001 From: Michael Murtaugh Date: Thu, 17 Sep 2015 18:47:25 +0200 Subject: [PATCH] updated README --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b7c9b58..36d82f1 100644 --- a/README.md +++ b/README.md @@ -16,29 +16,30 @@ Installation ------------- pip install html5lib jinja2 + python setup.py install Padinfo file ------------- -The easiest way to use etherdump is to create a padinfo JSON file that contains all the information necessary to connect to a particular etherpad server (including hostname, port, and API key). +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! - cp padinfo.sample.json padinfo.json + cp padinfo.sample.json ~/yourfolder/padinfo.json nano padinfo.json And then for instance: - etherdump --padinfo padinfo.json listpads + etherdump list -listpads +subcommands ---------- -To dump the names of the pads in JSON format: +* dump (the default) +* list +* listauthors +* text +* diffhtml +* revisionscount - ./etherdump --padinfo padinfo.json listpads - - ./etherdump --padinfo padinfo.json listpads > pads.json - -To format for the screen add the --lines option: - - ./etherdump --padinfo padinfo.json listpads --lines +To get help on a subcommand: + etherdump revisionscount --help