Update README.md

README.md

@@ -8,7 +8,9 @@ To enable plugin, you need to set the `MKDOCS_TO_CONFLUENCE` environment variabl
 ```BASH
 export MKDOCS_TO_CONFLUENCE=1
 ```
+
 By default the dry-run mode is turned off. If you wan't to enable it, you can use the config file, ot the `MKDOCS_TO_CONFLUENCE_DRY_RUN` environment variable
+
 ```BASH
 export MKDOCS_TO_CONFLUENCE_DRY_RUN=1
 ```
@@ -16,13 +18,12 @@ export MKDOCS_TO_CONFLUENCE_DRY_RUN=1
 ## Setup
 Install the plugin using pip:
 
-`pip install mkdocs-with-confluence`
+`pip install https://github.com/allanger/mkdocs-with-confluence/releases/download/v0.3.1/mkdocs_with_confluence-0.3.1.tar.gz`
 
 Activate the plugin in `mkdocs.yml`:
 
 ```yaml
 plugins:
-  - search
   - mkdocs-with-confluence
 ```
 
@@ -37,12 +38,14 @@ Use following config and adjust it according to your needs:
         host_url: https://<YOUR_CONFLUENCE_DOMAIN>/rest/api/content
         space: <YOUR_SPACE>
         parent_page_name: <YOUR_ROOT_PARENT_PAGE>
-        username: <YOUR_USERNAME_TO_CONFLUENCE>
+        username: <YOUR_USERNAME_TO_CONFLUENCE> # JIRA_USERNAME env var can be used
-        password: <YOUR_PASSWORD_TO_CONFLUENCE>
+        password: <YOUR_PASSWORD_TO_CONFLUENCE> # JIRA_PASSWORD env var can be used
-        dryrun: true
+        dryrun: true # MKDOCS_TO_CONFLUENCE_DRY_RUN env var can be used
-```
+        header_message: <A_MESSAGE_THAT_WILL_BE_ADDED_TO_EVERY_PAGE>
+        upstream_url: <URL_OF_YOUR_MKDOCS_INTANCE>
+        header_warning: "‼️ This page is created automatically, all you changes will be overwritten during the next MKDocs deployment. Do not edit a page here ‼️"
 
-## Parameters:
+```
 
 ### Requirements
 - md2cf