Skip to content

Commit 6e64935

Browse files
authored
Update README.md (#103)
1 parent 3e9cd55 commit 6e64935

File tree

2 files changed

+142
-9
lines changed

2 files changed

+142
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
# ExWebRTC
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/elixir-webrtc/ex_webrtc/8404c58384a42f1173ac391e0ad9f69be47881d0/logo_text.svg">
3+
<br />
4+
<a href="https://hex.pm/packages/ex_webrtc"><img src="https://img.shields.io/hexpm/v/ex_webrtc.svg" /></a>
5+
<a href="https://hexdocs.pm/ex_webrtc"><img src="https://img.shields.io/badge/api-docs-yellow.svg?style=flat" /></a>
6+
<a href="https://github.com/elixir-webrtc/ex_webrtc/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/elixir-webrtc/ex_webrtc/ci.yml?logo=github&label=CI" /></a>
7+
<a href="https://codecov.io/gh/elixir-webrtc/ex_webrtc"><img src="https://codecov.io/gh/elixir-webrtc/ex_webrtc/graph/badge.svg?token=PdnXfnnmNw" /></a>
8+
</p>
29

3-
[![Hex.pm](https://img.shields.io/hexpm/v/ex_webrtc.svg)](https://hex.pm/packages/ex_webrtc)
4-
[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/ex_webrtc)
5-
[![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)
6-
[![codecov](https://codecov.io/gh/elixir-webrtc/ex_webrtc/graph/badge.svg?token=PdnXfnnmNw)](https://codecov.io/gh/elixir-webrtc/ex_webrtc)
10+
---
711

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

1214
## Installation
1315

14-
Add `ex_webrtc` to dependencies in `mix.exs`
16+
Add `ex_webrtc` to the list of dependencies in `mix.exs`
1517

1618
```elixir
1719
def deps do
@@ -20,3 +22,12 @@ def deps do
2022
]
2123
end
2224
```
25+
26+
## Getting started
27+
28+
To get started with using Elixir WebRTC, checkout out:
29+
* 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
30+
* the [`apps` repo](https://github.com/elixir-webrtc/apps) with example applications built on top of Elixir WebRTC
31+
* the [documentation](https://hexdocs.pm/ex_webrtc/readme.html), especially the [`PeerConnection` module page](https://hexdocs.pm/ex_webrtc/ExWebRTC.PeerConnection.html)
32+
33+
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).

logo_text.svg

Lines changed: 122 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)