Browse Source

adding some markdown markup

pull/4/head
mb 5 years ago
committed by Luke Murphy
parent
commit
7fd8cdd1d9
No known key found for this signature in database GPG Key ID: 5E2EF5A63E3718CC
  1. 20
      README.md

20
README.md

@ -89,6 +89,7 @@ Installation
-------------
`$ pip install python-dateutil jinja2 html5lib`
`$ python setup.py install`
Example
@ -105,15 +106,18 @@ The program then interactively asks some questions:
```
Please type the URL of the etherpad:
https://pad.vvvvvvaria.org/
The APIKEY is the contents of the file APIKEY.txt in the etherpad folder
Please paste the APIKEY:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
https://pad.vvvvvvaria.org/
```
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.
The settings are placed in a file called `.etherdump/settings.json` and are used (by default) by future commands.
Subcommands
----------
@ -133,7 +137,7 @@ Subcommands
To get help on a subcommand:
etherdump revisionscount --help
`$ etherdump revisionscount --help`
License
@ -141,5 +145,5 @@ License
GNU AFFERO GENERAL PUBLIC LICENSE, Version 3
See License.txt
See `License.txt`

Loading…
Cancel
Save