Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Herschel committed Nov 22, 2020
1 parent a78baa8 commit eeb913d
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# puremp3

[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
[![crates.io](https://img.shields.io/crates/v/puremp3.svg)](https://crates.io/crates/puremp3)
[![docs.rs](https://docs.rs/puremp3/badge.svg)](https://docs.rs/puremp3)
[![CircleCI](https://circleci.com/gh/Herschel/puremp3.svg?style=svg)](https://circleci.com/gh/Herschel/puremp3)

An MP3 decoder written in pure Rust.

This project is currently unmaintained and probably not suitable for production. Pull requests are accepted.

The motivation for this crate is to create a pure Rust MP3 decoder that easily compiles to the `wasm32-unknown-unknown` target. No claims are made to accuracy, performance, or compatibility. For a more robust decoder, try [minimp3-rs](https://github.com/germangb/minimp3-rs).

## Support

* MPEG-1/MPEG-2/MPEG-2.5 Layer III
- MPEG-1/MPEG-2/MPEG-2.5 Layer III

## Example

Expand All @@ -25,19 +29,19 @@ for (left, right) in samples {

The following implementations and documents were referenced in creating this crate:

* [PDMP3](https://github.com/technosaurus/PDMP3)
* [OpenMP3](https://github.com/audioboy77/OpenMP3)
* [minimp3](https://github.com/lieff/minimp3)
* [minimp3-rs](https://github.com/germangb/minimp3-rs)
* [Let's build an MP3-decoder!](http://blog.bjrn.se/2008/10/lets-build-mp3-decoder.html)
* [MP3 Decoder Master's Thesis](https://sites.google.com/a/kmlager.com/www/projects)
- [PDMP3](https://github.com/technosaurus/PDMP3)
- [OpenMP3](https://github.com/audioboy77/OpenMP3)
- [minimp3](https://github.com/lieff/minimp3)
- [minimp3-rs](https://github.com/germangb/minimp3-rs)
- [Let's build an MP3-decoder!](http://blog.bjrn.se/2008/10/lets-build-mp3-decoder.html)
- [MP3 Decoder Master's Thesis](https://sites.google.com/a/kmlager.com/www/projects)

## License

Licensed under either of

* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
* Creative Commons CC0 1.0 Universal Public Domain Dedication ([LICENSE-CC0](LICENSE-CC0) or https://creativecommons.org/publicdomain/zero/1.0/)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
- Creative Commons CC0 1.0 Universal Public Domain Dedication ([LICENSE-CC0](LICENSE-CC0) or https://creativecommons.org/publicdomain/zero/1.0/)

at your option.

Expand Down

0 comments on commit eeb913d

Please sign in to comment.