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

synced README with reality

Browse Source
This commit is contained in:
Michael Murtaugh 2016-10-17 13:06:56 +02:00
parent bda09e21ec
commit 423832f125
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -16,22 +16,29 @@ Installation
pip install python-dateutil html5lib pip install python-dateutil html5lib
python setup.py install python setup.py install
Padinfo file Example
------------- ---------------
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! mkdir mydump
cd myddump
etherdump init
cp padinfo.sample.json ~/yourfolder/padinfo.json The program then interactively asks some questions:
nano padinfo.json
And then for instance: 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
The settings are placed in a file called .etherdump/settings.json and are used (by default) by future commands.
etherdump list
subcommands subcommands
---------- ----------
* sync * init
* pull
* list * list
* listauthors * listauthors
* gettext * gettext