diff --git a/README.md b/README.md index 83d6987..8a07d1a 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ # Mark -Mark it's tool for syncing your markdown documentation with Atlassian Confluence pages. +Mark it's tool for syncing your markdown documentation with Atlassian +Confluence pages. This is very usable if you store documentation to your orthodox software in git repository and don't want to do a handjob with updating Confluence page using fucking tinymce wysiwyg enterprise core editor. You can store a user credentials in the configuration file, which should be -located in ~/.config/mark with following format: +located in `~/.config/mark` with following format: ``` username = "smith" password = "matrixishere" ``` Mark can read Confluence page URL and markdown file path from another specified -configuration file, which you can specify using -c flag. It is very +configuration file, which you can specify using `-c ` flag. It is very usable for git hooks. That file should have following format: ```toml url = "http://confluence.local/pages/viewpage.action?pageId=123456" @@ -23,8 +24,8 @@ file = "docs/README.md" ## Usage: ``` -mark [-u ] [-p ] -l -f -mark [-u ] [-p ] -c +mark [--dry-run] [-u ] [-p ] -l -f +mark [--dry-run] [-u ] [-p ] -c mark -v | --version mark -h | --help ``` @@ -33,6 +34,8 @@ mark -h | --help - `-p ` - Use specified password for updating Confluence page. - `-l ` - Edit specified Confluence page. - `-f ` - Use specified markdown file for converting to html. -- `-c ` - Specify configuration file which should be used for reading Confluence page URL and markdown file path. +- `-c ` - Specify configuration file which should be used for reading + Confluence page URL and markdown file path. +- `--dry-run` - Show resulting HTML and don't update Confluence page content. - `-v | --version` - Show version. - `-h | --help` - Show help screen and call 911.