netzbon readme

1 files changed, 28 insertions, 0 deletions

diff --git a/netzbon/README b/netzbon/README
index d74f8a5..d32c225 100644
--- a/netzbon/README
+++ b/netzbon/README
@@ -7,6 +7,34 @@ main.sh is the main script that asks the questions and
 puts the answers in environment variables and/or replaces them
 into Nginx configuration file(s).
 
+Domain names
+============
+
+Assuming a main domain at netzbon.ch, this setup expects the
+following subdomains to be reachable:
+
+- exchange.netzbon.ch
+- bank.netzbon.ch
+- backend.netzbon.ch (merchants frontends need this)
+
+Funding of bank accounts
+========================
+
+After a successful installation, all the services are running
+and the administrator can create bank accounts and wire funds
+to them.  The script "transfer.sh" in this directory serves this
+purpose; running it without arguments shows the usage instructions.
+
+Note: The wiring of funds causes the amount to be subtracted to
+the administrator.  Following is one example of wiring funds from
+the administrator to the "shop" bank account. 
+
+  $ ./transfer.sh shop NETZBON:10 "welcome amount"
+
+If the command succeeded, the 'shop' bank account has received
+one payment of 10 NETZBONs from 'admin' with the subject "welcome
+amount".
+
 Concept
 =======