Skip to content

Commit 74e2e4d

Browse files
committed
updated readme, todo: move example to gh-pages
1 parent 5b28107 commit 74e2e4d

File tree

3 files changed

+831
-586
lines changed

3 files changed

+831
-586
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,25 @@ Or using bower: ```$ bower install rtc-scamp```
2424

2525
## Usage
2626

27-
This module creates a network which implements the
28-
[p2pnetwork API](https://github.com/justayak/network). It uses
27+
This module creates a network which implements the [p2pnetwork
28+
API](https://github.com/justayak/network). It uses
2929
[rtc-scamp-mbr](http://github.com/chat-wane/rtc-scamp-mbr) for the membership
3030
part, i.e., how a peer can join the network. It uses
31-
simple-broadcast-definition for the epidemic dissemination of messages which
32-
collects the unique identifier of each message so they are broadcast only once.
31+
[simple-broadcast-definition](https://github.com/Chat-Wane/PrimitiveBroadcastDefinition.git)
32+
for the epidemic dissemination of messages which collects the unique identifier
33+
of each message so they are broadcast only once.
3334

3435
## Example
3536

36-
There is a small example in the eponymous folder. To start it, follow the
37-
steps:
37+
The example is hosted [here](http://chat-wane.github.io/rtc-SCAMP/). The code
38+
can be found on the
39+
[gh-branch](https://github.com/Chat-Wane/rtc-SCAMP/tree/gh-pages) of this
40+
project. To use it, follow the steps:
3841
<ol>
39-
<li>Download or clone the project</li>
40-
<li>Open the index.html file with any WebRTC compatible web
41-
browser (e.g. Chrome)</li>
42+
<li>Open the link with any WebRTC compatible web browser (e.g. Chrome)</li>
4243
<li>Click on "1. Make offer". 3 seconds later, a string appears in the
4344
text area. Copy the string.</li>
44-
<li>Open a new tab with the same html file and paste the string inside the
45+
<li>Open a new tab with the same link and paste the string inside the
4546
empty textarea.</li>
4647
<li>Click on "2. Accept offer". 3 seconds later, the string in the text area
4748
changes. Copy the string.</li>

0 commit comments

Comments
 (0)