Skip to content

Commit b10d092

Browse files
Merge pull request #24 from membraneframework/update_readme
Update readme - add info about libnice installation
2 parents ebef6fd + 3ef6bea commit b10d092

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,20 @@ It is a part of [Membrane Multimedia Framework](https://membraneframework.org).
1010

1111
## Installation
1212

13+
First, install [libnice] on your system:
14+
15+
### macOS
16+
17+
```bash
18+
brew install libnice
19+
```
20+
21+
### Ubuntu
22+
23+
```bash
24+
sudo apt-get install libnice-dev
25+
```
26+
1327
The package can be installed by adding `ex_libnice` to your list of dependencies in `mix.exs`:
1428

1529
```elixir
@@ -40,6 +54,7 @@ config :ex_libnice, mdns: false
4054
Example flow can look in the following way (this is not complete i.e. runnable example).
4155

4256
Listed functions must be invoked on both peers.
57+
4358
```elixir
4459
# Init ExLibnice
4560
{:ok, pid} =
@@ -90,12 +105,10 @@ This will start connectivity checks. Receiving message
90105
`{:component_state_ready, stream_id, component_id}` indicates that the given component in the given
91106
stream is ready to send and receive messages.
92107

93-
94108
For more complete examples please refer to
95109
[membrane_ice_plugin](https://github.com/membraneframework/membrane_ice_plugin) where we use
96110
`ex_libnice` or our integration test.
97111

98-
99112
## Copyright and License
100113

101114
Copyright 2020, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=membrane_ice)
@@ -105,4 +118,3 @@ Copyright 2020, [Software Mansion](https://swmansion.com/?utm_source=git&utm_med
105118
Licensed under the [Apache License, Version 2.0](LICENSE)
106119

107120
[libnice]: https://libnice.freedesktop.org/
108-

0 commit comments

Comments
 (0)