diff --git a/README.md b/README.md index d60f89b..2b31f23 100644 --- a/README.md +++ b/README.md @@ -1 +1,55 @@ -sudo apt-get install libasound2-dev \ No newline at end of file +
+

+

deno_audio

+ +

+ Audio playback library for Deno. +

+

+ + [![stars](https://img.shields.io/github/stars/littledivy/deno_audio)](https://github.com/divy-work/deno_audio/stargazers) + [![issues](https://img.shields.io/github/issues/littledivy/deno_audio)](https://github.com/divy-work/deno_audio/issues) + ![deno version](https://img.shields.io/badge/deno-1.5.1-success) + +

+

+ + + +## Example + +```typescript +import { play } from "https://deno.land/audio@0.1.0/mod.ts"; + +// supports mp3, wav, vorbis, flac +await play("music.mp3"); +``` + +## Building from source + +### Prerequisites + +- [deno](https://deno.land/) +- [rust](https://www.rust-lang.org/) +- libasound2-dev - `apt-get install libasound2-dev` + +## Building +```bash +$ cargo build +``` + +## Example + +```bash +$ deno run --unstable -A example.ts +``` + +### Contribution + +Pull request, issues and feedback are very welcome. Code style is formatted with `deno fmt` and commit messages are done following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec. + +## Copyright + +deno_audio is licensed under the MIT license. Please see the [LICENSE](LICENSE) file.