Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

Commit

Permalink
Examples: Add readme
Browse files Browse the repository at this point in the history
Relates to #5
  • Loading branch information
backkem committed Feb 14, 2019
1 parent db99ed5 commit eb57afb
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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
```
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit eb57afb

Please sign in to comment.