Skip to content

docs: README: make setup and requirements clearer #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: README: make setup and requirements clearer #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@

## Setup

* Install `webrtc-socket-proxy`
* Install `webrtc-socket-proxy` on both peers

```
$ go get -u github.com/poga/webrtc-socket-proxy
```

* Setup [centrifugo](https://github.com/centrifugal/centrifugo/releases) with [example config](config.centrifugo.test.json).
* On the third machine with a dedicated IP, setup [centrifugo](https://github.com/centrifugal/centrifugo/releases) with [example config](config.centrifugo.test.json).

## Usage

Expand All @@ -30,7 +30,7 @@ $ webrtc-socket-proxy -signal=<SIGNAL_SERVER_ADDR> -secret=<SIGNAL_SERVER_SECRET
$ webrtc-socket-proxy -signal=<SIGNAL_SERVER_ADDR> -secret=<SIGNAL_SERVER_SECRET> -to=<PEER_ID> -listen=:4444
```

You can send data to your `<upstreamAddr>` via connecting to `:4444` now.
You can send data from the `As` machine to your `<upstreamAddr>` via connecting to `:4444` of the `To` machine now.

## Roadmap

Expand All @@ -39,4 +39,4 @@ You can send data to your `<upstreamAddr>` via connecting to `:4444` now.

## License

The MIT License
The MIT License