Skip to content
This repository has been archived by the owner on Apr 24, 2023. It is now read-only.

Adds install/set up instructions to the readme. #435

Closed
wants to merge 2 commits into from
Closed

Adds install/set up instructions to the readme. #435

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87f8a71
Adds install/set up instructions to the readme.
johnnymatthews May 24, 2022
b8ac190
Removes code output so users don't copy that to clipboard.
johnnymatthews May 24, 2022
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
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,32 @@
* [`/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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will install the current release version of @libp2p/webrtc-star-signalling-server and not the one from this repo.

If you want the release version you could skip steps 1 & 2.

If you want the version from this repo you need to npm i after step 2, then npm link in the signalling server folder.

As it stands this duplicates the installation instructions from the webrtc-star-signalling-server package README, you could just link to them?

```

1. Start the webrtc server:

```shell
webrtc-star --port=13579 --host=127.0.0.1
```

## Contribute

Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-interfaces/issues)!
Expand Down