Release v0.0.1 (#7)

Author: varsill

README.md

@@ -4,7 +4,7 @@
 [![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/ex_hls)
 [![CircleCI](https://circleci.com/gh/membraneframework/ex_hls.svg?style=svg)](https://circleci.com/gh/membraneframework/ex_hls)
 
-This repository contains ExHLS - an Elixir package for handling HLS streams
+This repository contains ExHLS - an Elixir package for handling HLS streams.
 
 It's a part of the [Membrane Framework](https://membrane.stream).
 
@@ -15,14 +15,47 @@ The package can be installed by adding `ex_hls` to your list of dependencies in
 ```elixir
 def deps do
   [
-    {:ex_hls, "~> 0.1.0"}
+    {:ex_hls, "~> 0.0.1"}
   ]
 end
 ```
 
 ## Usage
 
-TODO
+To read HLS stream from the `.m3u8 playlist`, start the client with:
+```elixir
+client = ExHLS.Client.new(<URI of the .m3u8 playlist>)
+```
+
+Then you can inspect the variants available in your playlist:
+```elixir
+ExHLS.Client.get_variants(client)
+# Returns:
+#   %{
+#     0 => %{
+#       id: 0,
+#       name: "720",
+#       uri: "url_0/193039199_mp4_h264_aac_hd_7.m3u8",
+#       codecs: "mp4a.40.2,avc1.64001f",
+#       bandwidth: 2149280,
+#       resolution: {1280, 720},
+#       frame_rate: nil
+#     },
+#     ...
+#   }
+```
+
+If there are multiple variants available, you need to choose one of them with:
+```elixir
+ExHLS.Client.choose_variant(<id>)
+```
+where `<id>` is the `id` field of the entry returned by `ExHLS.Client.get_variants/1`.
+
+Now you can start reading media with the following functions:
+```elixir
+{video_chunk, client} = ExHLS.Client.read_video_chunk(client)
+{audio_chunk, client} = ExHLS.Client.read_audio_chunk(client)
+```
 
 ## Copyright and License
 

mix.exs

@@ -1,8 +1,8 @@
 defmodule ExHLS.Mixfile do
   use Mix.Project
 
-  @version "0.1.0"
-  @github_url "https://github.com/membraneframework-labs/ex_hls"
+  @version "0.0.1"
+  @github_url "https://github.com/membraneframework/ex_hls"
 
   def project do
     [
@@ -42,7 +42,7 @@ defmodule ExHLS.Mixfile do
       {:qex, "~> 0.5.1"},
       {:membrane_mp4_plugin, "~> 0.36.0"},
       {:membrane_h26x_plugin, "~> 0.10.2"},
-      {:mpeg_ts, github: "kim-company/kim_mpeg_ts"},
+      {:mpeg_ts, "~> 2.0.0"},
       {:ex_doc, ">= 0.0.0", only: :dev, runtime: false},
       {:dialyxir, ">= 0.0.0", only: :dev, runtime: false},
       {:credo, ">= 0.0.0", only: :dev, runtime: false}

mix.lock

@@ -31,7 +31,7 @@
   "membrane_timestamp_queue": {:hex, :membrane_timestamp_queue, "0.2.2", "1c831b2273d018a6548654aa9f7fa7c4b683f71d96ffe164934ef55f9d11f693", [:mix], [{:heap, "~> 2.0", [hex: :heap, repo: "hexpm", optional: false]}, {:membrane_core, "~> 1.0", [hex: :membrane_core, repo: "hexpm", optional: false]}], "hexpm", "7c830e760baaced0988421671cd2c83c7cda8d1bd2b61fd05332711675d1204f"},
   "mime": {:hex, :mime, "2.0.7", "b8d739037be7cd402aee1ba0306edfdef982687ee7e9859bee6198c1e7e2f128", [:mix], [], "hexpm", "6171188e399ee16023ffc5b76ce445eb6d9672e2e241d2df6050f3c771e80ccd"},
   "mint": {:hex, :mint, "1.7.1", "113fdb2b2f3b59e47c7955971854641c61f378549d73e829e1768de90fc1abf1", [:mix], [{:castore, "~> 0.1.0 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:hpax, "~> 0.1.1 or ~> 0.2.0 or ~> 1.0", [hex: :hpax, repo: "hexpm", optional: false]}], "hexpm", "fceba0a4d0f24301ddee3024ae116df1c3f4bb7a563a731f45fdfeb9d39a231b"},
-  "mpeg_ts": {:git, "https://github.com/kim-company/kim_mpeg_ts.git", "ebde017bf639a9d57d068f029f2e43562ae78746", []},
+  "mpeg_ts": {:hex, :mpeg_ts, "2.0.2", "87f7d3b38c962fc367edbb4b1419f5f314be41a0d512b95437f11c4f60c931f4", [:mix], [], "hexpm", "5b7f1245a945de647c29abc9453e3d9d7eca1b0001d3d582f4feb11fc09b2792"},
   "nimble_options": {:hex, :nimble_options, "1.1.1", "e3a492d54d85fc3fd7c5baf411d9d2852922f66e69476317787a7b2bb000a61b", [:mix], [], "hexpm", "821b2470ca9442c4b6984882fe9bb0389371b8ddec4d45a9504f00a66f650b44"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
   "nimble_pool": {:hex, :nimble_pool, "1.1.0", "bf9c29fbdcba3564a8b800d1eeb5a3c58f36e1e11d7b7fb2e084a643f645f06b", [:mix], [], "hexpm", "af2e4e6b34197db81f7aad230c1118eac993acc0dae6bc83bac0126d4ae0813a"},