Skip to content

Commit 0186b0a

Browse files
committed
Add missing newlines in 'README.md' files
1 parent 7690dbd commit 0186b0a

File tree

22 files changed

+175
-5
lines changed

22 files changed

+175
-5
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,5 @@ Dual licensing under both MIT and Apache-2.0 is the currently accepted standard
142142

143143

144144
## Contributing
145+
145146
Contributors or Pull Requests are Welcome!!!

dtls/examples/certificates/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ $ rm "${EXTFILE}" "${SERVER_NAME}.csr" "${CLIENT_NAME}.csr"
2626
```
2727

2828
in pion/examples/util/util.go, convert ECPrivateKey to PKCS8PrivateKey
29+
2930
```go
3031
func LoadKey(path string) (crypto.PrivateKey, error) {
3132
....

examples/examples/broadcast/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
# broadcast
2+
23
broadcast is a WebRTC.rs application that demonstrates how to broadcast a video to many peers, while only requiring the broadcaster to upload once.
34

45
This could serve as the building block to building conferencing software, and other applications where publishers are bandwidth constrained.
56

67
## Instructions
8+
79
### Build broadcast
10+
811
```shell
912
cargo build --example broadcast
1013
```
1114

1215
### Open broadcast example page
16+
1317
[jsfiddle.net](https://jsfiddle.net/1jc4go7v/) You should see two buttons 'Publish a Broadcast' and 'Join a Broadcast'
1418

1519
### Run Broadcast
20+
1621
#### Linux/macOS
22+
1723
Run `broadcast`
1824

1925
### Start a publisher
@@ -26,6 +32,7 @@ Run `broadcast`
2632
* The connection state will be printed in the terminal and under `logs` in the browser.
2733

2834
### Join the broadcast
35+
2936
* Click `Join a Broadcast`
3037
* Copy the string in the first input labelled `Browser base64 Session Description`
3138
* Run `curl localhost:8080/sdp -d "$BROWSER_OFFER"`. `$BROWSER_OFFER` is the value you copied in the last step.

examples/examples/data-channels-create/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,33 @@
11
# data-channels-create
2+
23
data-channels-create is a WebRTC.rs application that shows how you can send/recv DataChannel messages from a web browser. The difference with the data-channels example is that the datachannel is initialized from the WebRTC.rs side in this example.
34

45
## Instructions
6+
57
### Build data-channels-create
8+
69
```shell
710
cargo build --example data-channels-create
811
```
912

1013
### Open data-channels-create example page
14+
1115
[jsfiddle.net](https://jsfiddle.net/swgxrp94/20/)
1216

1317
### Run data-channels-create
18+
1419
Just run `data-channels-create`.
1520

1621
### Input data-channels-create's SessionDescription into your browser
22+
1723
Copy the text that `data-channels-create` just emitted and copy into first text area of the jsfiddle.
1824

1925
### Hit 'Start Session' in jsfiddle
26+
2027
Hit the 'Start Session' button in the browser. You should see `have-remote-offer` below the `Send Message` button.
2128

2229
### Input browser's SessionDescription into data-channels-create
30+
2331
Meanwhile text has appeared in the second text area of the jsfiddle. Copy the text and paste it into `data-channels-create` and hit ENTER.
2432
In the browser you'll now see `connected` as the connection is created. If everything worked you should see `New DataChannel data`.
2533

examples/examples/data-channels-detach-create/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ This allows direct access the the underlying [webrtc-rs/data](https://github.com
66
The example mirrors the data-channels-create example.
77

88
## Install
9+
910
```shell
1011
cargo build --example data-channels-detach-create
1112
```
1213

1314
## Usage
15+
1416
The example can be used in the same way as the [Data Channels Create](data-channels-create) example.

examples/examples/data-channels-detach/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
11
# data-channels
2+
23
data-channels is a WebRTC.rs application that shows how you can send/recv DataChannel messages from a web browser
34

45
## Instructions
6+
57
### Build data-channels-detach
8+
69
```shell
710
cargo build --example data-channels-detach
811
```
912

1013
### Open data-channels-detach example page
14+
1115
[jsfiddle.net](https://jsfiddle.net/9tsx15mg/90/)
1216

1317
### Run data-channels-detach, with your browsers SessionDescription as stdin
18+
1419
In the jsfiddle the top textarea is your browser's session description, copy that and:
20+
1521
#### Linux/macOS
22+
1623
Run `echo $BROWSER_SDP | ./target/debug/examples/data-channels-detach`
24+
1725
#### Windows
26+
1827
1. Paste the SessionDescription into a file.
1928
1. Run `./target/debug/examples/data-channels-detach < my_file`
2029

2130
### Input data-channels-detach's SessionDescription into your browser
31+
2232
Copy the text that `data-channels` just emitted and copy into second text area
2333

2434
### Hit 'Start Session' in jsfiddle
35+
2536
Under Start Session you should see 'Checking' as it starts connecting. If everything worked you should see `New DataChannel foo 1`
2637

2738
Now you can put whatever you want in the `Message` textarea, and when you hit `Send Message` it should appear in your terminal!

examples/examples/data-channels-flow-control/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# data-channels-flow-control
2+
23
This example demonstrates how to use the following property / methods.
34

45
* pub async fn buffered_amount(&self) -> usize
@@ -10,6 +11,7 @@ These methods are equivalent to that of JavaScript WebRTC API.
1011
See https://developer.mozilla.org/en-US/docs/Web/API/RTCDataChannel for more details.
1112

1213
## When do we need it?
14+
1315
Send or SendText methods are called on DataChannel to send data to the connected peer.
1416
The methods return immediately, but it does not mean the data was actually sent onto
1517
the wire. Instead, it is queued in a buffer until it actually gets sent out to the wire.
@@ -23,6 +25,7 @@ actually send to the peer over the Internet. The above properties/methods help y
2325
application to pace the amount of data to be pushed into the data channel.
2426

2527
## How to run the example code
28+
2629
The demo code implements two endpoints (requester and responder) in it.
2730

2831
```plain

examples/examples/data-channels/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
11
# data-channels
2+
23
data-channels is a WebRTC.rs application that shows how you can send/recv DataChannel messages from a web browser
34

45
## Instructions
6+
57
### Build data-channels
8+
69
```shell
710
cargo build --example data-channels
811
```
912

1013
### Open data-channels example page
14+
1115
[jsfiddle.net](https://jsfiddle.net/9tsx15mg/90/)
1216

1317
### Run data-channels, with your browsers SessionDescription as stdin
18+
1419
In the jsfiddle the top textarea is your browser's session description, copy that and:
20+
1521
#### Linux/macOS
22+
1623
Run `echo $BROWSER_SDP | ./target/debug/examples/data-channels`
24+
1725
#### Windows
26+
1827
1. Paste the SessionDescription into a file.
1928
1. Run `./target/debug/examples/data-channels < my_file`
2029

2130
### Input data-channels's SessionDescription into your browser
31+
2232
Copy the text that `data-channels` just emitted and copy into second text area
2333

2434
### Hit 'Start Session' in jsfiddle
35+
2536
Under Start Session you should see 'Checking' as it starts connecting. If everything worked you should see `New DataChannel foo 1`
2637

2738
Now you can put whatever you want in the `Message` textarea, and when you hit `Send Message` it should appear in your terminal!

examples/examples/insertable-streams/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# insertable-streams
2+
23
insertable-streams demonstrates how to use insertable streams with WebRTC.rs.
34
This example modifies the video with a single-byte XOR cipher before sending, and then
45
decrypts in Javascript.
@@ -7,33 +8,43 @@ insertable-streams allows the browser to process encoded video. You could implem
78
E2E encyption, add metadata or insert a completely different video feed!
89

910
## Instructions
11+
1012
### Create IVF named `output.ivf` that contains a VP8 track
13+
1114
```shell
1215
ffmpeg -i $INPUT_FILE -g 30 output.ivf
1316
```
1417

1518
### Build insertable-streams
19+
1620
```shell
1721
cargo build --example insertable-streams
1822
```
1923

2024
### Open insertable-streams example page
25+
2126
[jsfiddle.net](https://jsfiddle.net/uqr80Lak/) you should see two text-areas and a 'Start Session' button. You will also have a 'Decrypt' checkbox.
2227
When unchecked the browser will not decrypt the incoming video stream, so it will stop playing or display certificates.
2328

2429
### Run insertable-streams with your browsers SessionDescription as stdin
30+
2531
The `output.ivf` you created should be in the same directory as `insertable-streams`. In the jsfiddle the top textarea is your browser, copy that and:
2632

2733
#### Linux/macOS
34+
2835
Run `echo $BROWSER_SDP | ./target/debug/examples/insertable-streams`
36+
2937
#### Windows
38+
3039
1. Paste the SessionDescription into a file.
3140
1. Run `./target/debug/examples/insertable-streams < my_file`
3241

3342
### Input insertable-streams's SessionDescription into your browser
43+
3444
Copy the text that `insertable-streams` just emitted and copy into second text area
3545

3646
### Hit 'Start Session' in jsfiddle, enjoy your video!
47+
3748
A video should start playing in your browser above the input boxes. `insertable-streams` will exit when the file reaches the end.
3849

3950
To stop decrypting the stream uncheck the box and the video will not be viewable.

examples/examples/offer-answer/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
# offer-answer
2+
23
offer-answer is an example of two webrtc-rs or pion instances communicating directly!
34

45
The SDP offer and answer are exchanged automatically over HTTP.
56
The `answer` side acts like a HTTP server and should therefore be ran first.
67

78
## Instructions
9+
810
First run `answer`:
11+
912
```shell
1013
cargo build --example answer
1114
./target/debug/examples/answer
1215
```
16+
1317
Next, run `offer`:
18+
1419
```shell
1520
cargo build --example offer
1621
./target/debug/examples/offer

examples/examples/ortc/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# ortc
2+
23
ortc demonstrates WebRTC.rs's [ORTC](https://ortc.org/) capabilities. Instead of using the Session Description Protocol
34
to configure and communicate ORTC provides APIs. Users then can implement signaling with whatever protocol they wish.
45
ORTC can then be used to implement WebRTC. A ORTC implementation can parse/emit Session Description and act as a WebRTC
@@ -7,20 +8,25 @@ implementation.
78
In this example we have defined a simple JSON based signaling protocol.
89

910
## Instructions
11+
1012
### Build ortc
13+
1114
```shell
1215
cargo build --example ortc
1316
```
1417

1518
### Run first client as offerer
19+
1620
`ortc --offer` this will emit a base64 message. Copy this message to your clipboard.
1721

1822
## Run the second client as answerer
23+
1924
Run the second client. This should be launched with the message you copied in the previous step as stdin.
2025

2126
`echo BASE64_MESSAGE_YOU_COPIED | ortc`
2227

2328
### Enjoy
29+
2430
If everything worked you will see `Data channel 'Foo'-'' open.` in each terminal.
2531

2632
Each client will send random messages every 5 seconds that will appear in the terminal
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,45 @@
11
# play-from-disk-h264
2+
23
play-from-disk-h264 demonstrates how to send h264 video and/or audio to your browser from files saved to disk.
34

45
## Instructions
6+
57
### Create IVF named `output.264` that contains a H264 track and/or `output.ogg` that contains a Opus track
8+
69
```shell
710
ffmpeg -i $INPUT_FILE -an -c:v libx264 -bsf:v h264_mp4toannexb -b:v 2M -max_delay 0 -bf 0 output.h264
811
ffmpeg -i $INPUT_FILE -c:a libopus -page_duration 20000 -vn output.ogg
912
```
1013

1114
### Build play-from-disk-h264
15+
1216
```shell
1317
cargo build --example play-from-disk-h264
1418
```
1519

1620
### Open play-from-disk-h264 example page
21+
1722
[jsfiddle.net](https://jsfiddle.net/9s10amwL/) you should see two text-areas and a 'Start Session' button
1823

1924
### Run play-from-disk-h264 with your browsers SessionDescription as stdin
25+
2026
The `output.h264` you created should be in the same directory as `play-from-disk-h264`. In the jsfiddle the top textarea is your browser, copy that and:
2127

2228
#### Linux/macOS
29+
2330
Run `echo $BROWSER_SDP | ./target/debug/examples/play-from-disk-h264 -v examples/test-data/output.h264 -a examples/test-data/output.ogg`
31+
2432
#### Windows
33+
2534
1. Paste the SessionDescription into a file.
2635
1. Run `./target/debug/examples/play-from-disk-h264 -v examples/test-data/output.h264 -a examples/test-data/output.ogg < my_file`
2736

2837
### Input play-from-disk-h264's SessionDescription into your browser
38+
2939
Copy the text that `play-from-disk-h264` just emitted and copy into second text area
3040

3141
### Hit 'Start Session' in jsfiddle, enjoy your video!
42+
3243
A video should start playing in your browser above the input boxes. `play-from-disk-h264` will exit when the file reaches the end
3344

3445
Congrats, you have used WebRTC.rs!
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
11
# play-from-disk-renegotiation
2+
23
play-from-disk-renegotiation demonstrates WebRTC.rs's renegotiation abilities.
34

45
For a simpler example of playing a file from disk we also have [examples/play-from-disk](/examples/play-from-disk)
56

67
## Instructions
78

89
### Build play-from-disk-renegotiation
10+
911
```shell
1012
cargo build --example play-from-disk-renegotiation
1113
```
1214

1315
### Create IVF named `output.ivf` that contains a VP8 track
16+
1417
```shell
1518
ffmpeg -i $INPUT_FILE -g 30 output.ivf
1619
```
1720

1821
### Run play-from-disk-renegotiation
19-
The `output.ivf` you created should be in the same directory as `play-from-disk-renegotiation`.
22+
23+
The `output.ivf` you created should be in the same directory as `play-from-disk-renegotiation`.
24+
2025

2126
### Open the Web UI
27+
2228
Open [http://localhost:8080](http://localhost:8080) and you should have a `Add Track` and `Remove Track` button. Press these to add as many tracks as you want, or to remove as many as you wish.
2329

2430
Congrats, you have used WebRTC.rs!

0 commit comments

Comments
 (0)