Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #103

Merged
merged 4 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# ExWebRTC
<p align="center">
<img src="https://raw.githubusercontent.com/elixir-webrtc/ex_webrtc/8404c58384a42f1173ac391e0ad9f69be47881d0/logo_text.svg">
<br />
<a href="https://hex.pm/packages/ex_webrtc"><img src="https://img.shields.io/hexpm/v/ex_webrtc.svg" /></a>
<a href="https://hexdocs.pm/ex_webrtc"><img src="https://img.shields.io/badge/api-docs-yellow.svg?style=flat" /></a>
<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>
<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>
</p>

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

Implementation of the [W3C WebRTC API](https://www.w3.org/TR/webrtc/) in Elixir.

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

## Installation

Add `ex_webrtc` to dependencies in `mix.exs`
Add `ex_webrtc` to the list of dependencies in `mix.exs`

```elixir
def deps do
Expand All @@ -20,3 +22,12 @@ def deps do
]
end
```

## Getting started

To get started with using Elixir WebRTC, checkout out:
* 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
* the [`apps` repo](https://github.com/elixir-webrtc/apps) with example applications built on top of Elixir WebRTC
* the [documentation](https://hexdocs.pm/ex_webrtc/readme.html), especially the [`PeerConnection` module page](https://hexdocs.pm/ex_webrtc/ExWebRTC.PeerConnection.html)

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).
122 changes: 122 additions & 0 deletions logo_text.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.