varia/etherpump
14
0
Fork 0
Code Issues 15 Pull Requests Releases Activity

updated README

Browse Source
This commit is contained in:
Michael Murtaugh 2015-09-17 18:47:25 +02:00
parent 61d397eb6f
commit 3957c44faa
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -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