Merge pull request #173 from hagen-i2p/readme-fix

* README.md

README.md

@@ -104,21 +104,34 @@ i2p.conf:
 
 tunnels.cfg (filename of this config is subject of change):
 
-	 ; outgoing tunnel, to remote service    
+  ; outgoing tunnel sample, to remote service
-	[tunnel1]  
+  ; mandatory parameters:
-	type = client      ; mandatory   
+  ; * type -- always "client"
-	port = <integer>   ; mandatory, bind our side of tunnel to this local port  
+  ; * port -- local port to listen to
-	keys = <filename>  ; optional  
+  ; * destination -- i2p hostname
-	destination     = <ident>    ; mandatory  
+  ; optional parameters (may be omitted)
-	destinationport = <integer>  ; optional, port of remote i2p service  
+  ; * keys -- our identity, if unset, will be generated on every startup,
-	   
+  ;     if set and file missing, keys will be generated and placed to this file
-	 ; incoming tunnel, for local service(s)   
+	[IRC]
-	[tunnel2]   
+	type = client
-	type = server      ; mandatory   
+	port = 6668
-	host = <ident>     ; mandatory, hostname of our i2p service   
+	destination = irc.echelon.i2p
-	keys = <filename>  ; mandatory, hostname keys   
+	keys = irc-keys.dat
-	port = <integer>   ; mandatory, forward incoming connections from i2p to this port      
+
-	inport = <integer> ; optional, i2p service port   
+  ; incoming tunnel sample, for local service
-	accesslist = <ident>[,<ident>] ; optional, comma-separated list of i2p idents, allowed to connect to service  
+  ; mandatory parameters:
-
+  ; * type -- always "server"
-Note: '<ident>' type is a string like <hostname.i2p> or <abracadabra.b32.i2p>  
+  ; * host -- ip address of our service
+  ; * port -- port of our service
+  ; * keys -- file with LeaseSet of address in i2p
+  ; optional parameters (may be omitted)
+  ; * inport -- optional, i2p service port, if unset - the same as 'port'
+  ; * accesslist -- comma-separated list of i2p addresses, allowed to connect
+  ;    every address is b32 without '.b32.i2p' part
+	[LOCALSITE]
+	type = server
+	host = 127.0.0.1
+	port = 80
+	keys = site-keys.dat
+	inport = 81
+	accesslist = <b32>[,<b32>]