summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorrsiddharth <rsiddharth@ninthfloor.org>2014-01-02 15:24:17 +0530
committerrsiddharth <rsiddharth@ninthfloor.org>2014-01-02 15:24:17 +0530
commit8ee23fa7d907554d70c02778a1ff5877bffe2a04 (patch)
treeeb2e809547b08785e9516b274d487ca382479369 /README.md
parentfeb156de3cb96b27580a20806d6bfe819b236a31 (diff)
updated README.md: Added `Configuration` section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index f4faeee..ef89bf9 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,17 @@ See [here for notes about the script][gns-deb-diff-notes].
that differ from Debian. Look at `packages-parkes.list` file for a
sample.
+## Configuration
+
+Specify the `wikiusername`, `passphrase` & the wiki's url at
+`src/config/topsecret.txt`.
+
+The `topsecret.txt` file must follow this format:
+
+ wikiusername
+ passphrase
+ http://wikiurl.ext
+
## Description
This is what the script does at present: