From 87f8a719515efe6ff10ae508e84481d1ec23dabb Mon Sep 17 00:00:00 2001 From: Johnny <9611008+johnnymatthews@users.noreply.github.com> Date: Tue, 24 May 2022 11:57:44 -0400 Subject: [PATCH 1/2] Adds install/set up instructions to the readme. --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 684cc2c9..dcefdbb4 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,35 @@ * [`/packages/transport`](./packages/webrtc-star-transport) The webrtc-star transport * [`/packages/protocol`](./packages/webrtc-star-protocol) Type definitions used by other packages +## Install + +1. Clone the repo: + + ```shell + git clone https://github.com/libp2p/js-libp2p-webrtc-star.git + ``` + +1. Move into the directory: + + ```shell + cd js-libp2p-webrtc-star + ``` + +1. Install the local `@libp2p` package: + + ```shell + npm install -g @libp2p/webrtc-star-signalling-server + ``` + +1. Start the webrtc server: + + ```shell + webrtc-star --port=13579 --host=127.0.0.1 + + > @libp2p/webrtc-star-signalling-server@1.0.5 + > Listening on: http://127.0.0.1:13579 + ``` + ## Contribute Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-interfaces/issues)! From b8ac190185810912e9aadaa0acb6e25255251e8f Mon Sep 17 00:00:00 2001 From: Johnny <9611008+johnnymatthews@users.noreply.github.com> Date: Tue, 24 May 2022 11:59:15 -0400 Subject: [PATCH 2/2] Removes code output so users don't copy that to clipboard. --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index dcefdbb4..6f591784 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,6 @@ ```shell webrtc-star --port=13579 --host=127.0.0.1 - - > @libp2p/webrtc-star-signalling-server@1.0.5 - > Listening on: http://127.0.0.1:13579 ``` ## Contribute