Skip to content

Commit

Permalink
Update readme to include chat app
Browse files Browse the repository at this point in the history
  • Loading branch information
D4nte committed Apr 1, 2021
1 parent ca845bd commit 184a38b
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,24 @@

A JavaScript implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2).

**This repo is a Work In Progress**
## This is a Work In Progress

You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1)

## Examples

## Chat app

A node chat app is provided as a working example of the library.
It is interoperable with the [nim-waku chat app example](https://github.com/status-im/nim-waku/blob/master/examples/v2/chat2.nim).
To run the chat app:

```shell
npm install
npm run chat:app -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ --listenAddr /ip4/0.0.0.0/tcp/55123
```

The `--listenAddr` parameter is optional, however [NAT passthrough](https://github.com/status-im/js-waku/issues/12) is not yet supported so you'll need the listen port to be opened to the internet to receive messages from the fleet.

## Contributing

Expand Down

0 comments on commit 184a38b

Please sign in to comment.