Rename to Mastering Transceivers

elixir-webrtc · Jan 12, 2024 · 79eea92 · 79eea92
1 parent ed86508
commit 79eea92
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/guides/transceiver_guide.md → guides/mastering_transceivers.md b/guides/transceiver_guide.md → guides/mastering_transceivers.md
@@ -1,4 +1,10 @@
-# Transceiver Guide
+# Mastering Transceivers
+
+> #### Before You Start {: .info}
+> This guide assumes you have a basic understanding of the WebRTC API
+> and are looking for more advanced examples that demonstrate what you can accomplish with transceivers.
+> If you are new to this, a good starting point might be to first look at the 
+> [MDN WebRTC tutorial](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API)
 
 A transceiver is an entity responsible both for sending and receiving media data.
 It consist of an RTP sender and RTP receiver.

diff --git a/mix.exs b/mix.exs
@@ -64,7 +64,7 @@ defmodule ExWebRTC.MixProject do
   defp docs() do
     [
       main: "readme",
-      extras: ["README.md", "guides/transceiver_guide.md"],
+      extras: ["README.md", "guides/mastering_transceivers.md"],
       source_ref: "v#{@version}",
       formatters: ["html"],
       before_closing_body_tag: &before_closing_body_tag/1,