rob
/
mpeg-audio-frame-parser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Rob Watson 2018-04-13 13:14:16 +02:00
parent dcdcaadd6f
commit 70828dd5c8
1 changed files with 2 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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.