From cae53651db06ef74640a36c8a19911f2bb4b5265 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Wala?= Date: Fri, 26 Apr 2024 12:13:24 +0200 Subject: [PATCH 1/4] Add the Elixir WebRTC logo with text --- logo_text.svg | 122 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 logo_text.svg diff --git a/logo_text.svg b/logo_text.svg new file mode 100644 index 00000000..348a77cb --- /dev/null +++ b/logo_text.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 8404c58384a42f1173ac391e0ad9f69be47881d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Wala?= Date: Fri, 26 Apr 2024 12:28:44 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c8704a53..93673ca2 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,21 @@ -# ExWebRTC +
+ + [![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 @@ -20,3 +24,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). From ba7e6b1273c05e4eaf665131c66a7aeb0bbb100c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Wala?= Date: Fri, 26 Apr 2024 12:33:25 +0200 Subject: [PATCH 3/4] Update readme to not use relative reference to the logo file --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 93673ca2..495bfa7b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- + [![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) From 849b8c03517f201cb375a64c4d2b48542b1fec3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Wala?= Date: Fri, 26 Apr 2024 13:10:49 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 495bfa7b..389ae40f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ -
- - - -[![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) +

+ +
+ + + + +

--- -
- **Elixir WebRTC** is an implementation of the [W3C WebRTC API](https://www.w3.org/TR/webrtc/) in the Elixir programming language. ## Installation