Skip to content
This repository has been archived by the owner on Feb 26, 2021. It is now read-only.

Commit

Permalink
Small readme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
mkg20001 committed Aug 29, 2017
1 parent de93825 commit 23f47e7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Currently websocket-star uses the /libp2p-webrtc-star/ address prefix as we don'

### Example

```JavaScript
```js
const libp2p = require("libp2p")
const Id = require("peer-id")
const Info = require("peer-info")
Expand Down Expand Up @@ -86,13 +86,13 @@ hello from the other side
`libp2p-webrtc-star` comes with its own signalling server, used for peers to handshake their signalling data and establish a connection. You can install it in your machine by installing the module globally:

```bash
> npm install --global libp2p-webrtc-star
> npm install --global libp2p-websocket-star
```

This will expose a `star-sig` cli tool. To spawn a server do:
This will expose a `ws-star-sig` cli tool. To spawn a server do:

```bash
> star-signal --port=9090 --host=127.0.0.1
> ws-star-signal --port=9090 --host=127.0.0.1
```

Defaults:
Expand All @@ -115,7 +115,7 @@ You can learn more about pull-streams at:

If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/pull-stream/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:

```JavaScript
```js
const pullToStream = require('pull-stream-to-stream')

const nodeStreamInstance = pullToStream(pullStreamInstance)
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "libp2p-websocket-star",
"version": "0.1.0",
"version": "0.1.1",
"description": "libp2p-webrtc-star without webrtc. Just plain socket.io.",
"main": "src/index.js",
"bin": {
Expand Down

0 comments on commit 23f47e7

Please sign in to comment.