Skip to content

Commit 6fbca91

Browse files
committed
Update README and mix.exs
1 parent 3a1f269 commit 6fbca91

File tree

2 files changed

+19
-7
lines changed

2 files changed

+19
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ def deps do
1717
end
1818
```
1919

20-
TODO add necessary steps
20+
If you want to use Converter to generate WEBM files from the recordings,
21+
you need to have the `ffmpeg` binary with the relevant libraries present in `PATH`.
22+
23+
### S3
2124

2225
ExWebRTC Recorder comes with optional support for uploading the recordings to S3-compatible storage,
23-
but it must be explicitely turned on by adding the following optional dependencies:
24-
* `:ex_aws_s3`
25-
* `:ex_aws`
26-
* `:sweet_xml`
27-
* an HTTP client (e.g. `:req`)
26+
but it must be explicitly turned on by adding the following dependencies:
2827

2928
```elixir
3029
def deps do
@@ -33,7 +32,9 @@ def deps do
3332
{:ex_aws_s3, "~> 2.5"},
3433
{:ex_aws, "~> 2.5"},
3534
{:sweet_xml, "~> 0.7"},
36-
{:req, "~> 0.5"}
35+
{:req, "~> 0.5"} # or any other HTTP client supported by `ex_aws`
3736
]
3837
end
3938
```
39+
40+
See `ExWebRTC.Recorder.S3` for more info.

mix.exs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ defmodule ExWebRTC.Recorder.MixProject do
1616
deps: deps(),
1717

1818
# docs
19+
docs: docs(),
1920
source_url: @source_url,
2021

2122
# dialyzer
@@ -69,4 +70,14 @@ defmodule ExWebRTC.Recorder.MixProject do
6970
{:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}
7071
]
7172
end
73+
74+
defp docs do
75+
[
76+
main: "readme",
77+
extras: ["README.md"],
78+
source_ref: "v#{@version}",
79+
formatters: ["html"],
80+
nest_modules_by_prefix: [ExWebRTC.Recorder]
81+
]
82+
end
7283
end

0 commit comments

Comments
 (0)