Update readme (fixes #16)

This commit is contained in:
Audrius Butkevicius
2015-11-21 00:13:14 +00:00
parent 20b925abec
commit 9d9ad6de88
+12 -5
View File
@@ -27,7 +27,7 @@ Make sure you have a public IP with port 22067 open, or make sure you have port-
Run the `relaysrv` with no arguments (or `-debug` if you want more output), and that should be enough for the server to join the public relay pool.
You should see a message saying:
```
2015/09/21 22:45:46 pool.go:60: Joined https://relays.syncthing.net rejoining in 48m0s
2015/09/21 22:45:46 pool.go:60: Joined https://relays.syncthing.net/endpoint rejoining in 48m0s
```
See `relaysrv -help` for other options, such as rate limits, timeout intervals, etc.
@@ -81,10 +81,17 @@ In the other terminal run the following:
Which should then give you an interactive prompt, where you can type things in one terminal, and they get relayed to the other terminal.
##### client
Relay related libraries used by this repo
----
##### Relay protocol definition.
A client library which is used by `syncthing`
[Available here](https://github.com/syncthing/syncthing/tree/master/lib/relay/protocol)
##### Relay client
Only used by the testutil.
[Available here](https://github.com/syncthing/syncthing/tree/master/lib/relay/client)
##### protocol
Go files which define the protocol and it's messages, and a few utility functions which make it easier to consume.