diff --git a/README.md b/README.md index a97d308..d25a47b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,5 @@ # Mp3FrameParser -**TODO: Add description** - -## Installation - -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `mp3_frame_parser` to your list of dependencies in `mix.exs`: - -```elixir -def deps do - [ - {:mp3_frame_parser, "~> 0.1.0"} - ] -end -``` - -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at [https://hexdocs.pm/mp3_frame_parser](https://hexdocs.pm/mp3_frame_parser). +Given a series of binary packets, extract any complete MP3 frames that can be found and return them to clients. +Currently WIP.