Skip to content

Commit 8404c58

Browse files
authored
Update README.md
1 parent cae5365 commit 8404c58

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# ExWebRTC
1+
<div align="center">
2+
3+
<img src="./logo_text.svg">
24

35
[![Hex.pm](https://img.shields.io/hexpm/v/ex_webrtc.svg)](https://hex.pm/packages/ex_webrtc)
46
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/ex_webrtc)
57
[![CI](https://img.shields.io/github/actions/workflow/status/elixir-webrtc/ex_webrtc/ci.yml?logo=github&label=CI)](https://github.com/elixir-webrtc/ex_webrtc/actions/workflows/ci.yml)
68
[![codecov](https://codecov.io/gh/elixir-webrtc/ex_webrtc/graph/badge.svg?token=PdnXfnnmNw)](https://codecov.io/gh/elixir-webrtc/ex_webrtc)
79

8-
Implementation of the [W3C WebRTC API](https://www.w3.org/TR/webrtc/) in Elixir.
10+
---
11+
12+
</div>
913

10-
See `examples` directory for usage examples.
14+
**Elixir WebRTC** is an implementation of the [W3C WebRTC API](https://www.w3.org/TR/webrtc/) in the Elixir programming language.
1115

1216
## Installation
1317

14-
Add `ex_webrtc` to dependencies in `mix.exs`
18+
Add `ex_webrtc` to the list of dependencies in `mix.exs`
1519

1620
```elixir
1721
def deps do
@@ -20,3 +24,12 @@ def deps do
2024
]
2125
end
2226
```
27+
28+
## Getting started
29+
30+
To get started with using Elixir WebRTC, checkout out:
31+
* the [examples directory](https://github.com/elixir-webrtc/ex_webrtc/tree/master/examples) which contains a bunch of very simple usage examples of the library
32+
* the [`apps` repo](https://github.com/elixir-webrtc/apps) with example applications built on top of Elixir WebRTC
33+
* the [documentation](https://hexdocs.pm/ex_webrtc/readme.html), especially the [`PeerConnection` module page](https://hexdocs.pm/ex_webrtc/ExWebRTC.PeerConnection.html)
34+
35+
If you have any questions, ideas or topics to discuss about Elixir WebRTC, head to the [discussions page](https://github.com/orgs/elixir-webrtc/discussions).

0 commit comments

Comments
 (0)