Examples: Add readme

Relates to #5
This commit is contained in:
backkem 2019-02-14 17:38:58 +01:00 committed by Michiel De Backker
parent db99ed5c56
commit eb57afb1c4
4 changed files with 69 additions and 0 deletions

69
examples/README.md Normal file
View File

@ -0,0 +1,69 @@
examples
===
## Go
This folder contains an example go app that connects using go-libp2p-webrtc-direct. It can be used as follows:
### Install dependencies
**TODO**: Check the root readme
### Listener
```sh
go run main.go -listen
```
*Output*
```
[listener] Listening
[listener] Got connection
[listener] Got stream
[listener] Received:
hey, how is it going. I am the dialer
Failed to accept data channel: The association is closed
```
The last line is harmless warning printed by the pions/webrtc library.
### Dialer
```sh
go run main.go
```
*Output*
```
Warning: Certificate not checked
[dialer] Opened connection
[dialer] Opened stream
Failed to push SCTP packet: Failed sending reply: dtls: conn is closed
Warning: mux: no endpoint for packet starting with 23
Failed to push SCTP packet: Failed sending reply: dtls: conn is closed
Warning: mux: no endpoint for packet starting with 21
Failed to accept data channel: The association is closed
```
The warnings printed by the pions/webrtc library are harmless.
## Javascript
The equivalent javascript example is also provided. It can be used as follows:
### Install dependencies
```sh
npm install
```
### Listener
```sh
node index.js --listen
```
*Output*
```
[listener] Listening
[listener] Got connection
[listener] Got stream
[listener] Received:
hey, how is it going. I am the dialer
```
### Dialer
```sh
node index.js
```
*Output*
```
[dialer] Opened connection
[dialer] Opened stream
```