aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2017-07-18 16:53:44 -0700
committerBryan Newbold <bnewbold@archive.org>2017-07-18 16:53:44 -0700
commitb2a203f3b3c6229de7d644859afa959a67ba2b25 (patch)
tree12dd68226f7edd34a1d904d8e1d22fadad427a10
parentda67e50a81f5d6b95ea3aabe06d9e16bdfc3729a (diff)
downloaddivergence-master.zip
divergence-master.tar.gz
document helper in READMEHEADmaster
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index df2b3e1..ddabe8c 100644
--- a/README.md
+++ b/README.md
@@ -31,8 +31,8 @@ it will Just Work without needing any administrative intervention.
# Usage
- export CONFLUENCE_USER=`whoami`
- export CONFLUENCE_PASSWORD="password123"
+ export CONFLUENCE_USER="user123"
+ export CONFLUENCE_PASSWORD="password456"
export CONFLUENCE_URL="https://evil-corp.jira.com/wiki/"
./divergence -s "PROD25" Acme_Widget_Docs.md
@@ -47,8 +47,16 @@ Multiple files can be uploaded at the same time.
If you have in-line images you'll need to upload them manually. Haven't tried
it yet.
-You might want to write a shell script wrapper to help with configuration and
-pushing multiple files to multiple spaces.
+You might want to write a shell script wrapper to automate configuration; you
+could also set these variable in `~/.profile` or similar:
+
+ #!/bin/bash
+
+ export CONFLUENCE_USER=`whoami`
+ export CONFLUENCE_PASSWORD=`pass evil-corp.jira.com | head -n1`
+ export CONFLUENCE_URL="https://evil-corp.jira.com/wiki/"
+
+ divergence -v $*
It's probably possible to use any pandoc-supported markup file format (not just
Markdown), but this hasn't been tested.