From 5b52666d9fb816722752e823728af0fb320d8a7d Mon Sep 17 00:00:00 2001 From: mb Date: Wed, 11 Sep 2019 20:12:43 +0200 Subject: [PATCH] adding some markdown markup --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b6e6f31..d017012 100644 --- a/README.md +++ b/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,6 +145,6 @@ License GNU AFFERO GENERAL PUBLIC LICENSE, Version 3 -See License.txt +See `License.txt`