Skip to content

Commit

Permalink
chores(docs): add README
Browse files Browse the repository at this point in the history
  • Loading branch information
littledivy committed Nov 3, 2020
1 parent e655c6d commit 4191771
Showing 1 changed file with 55 additions and 1 deletion.
56 changes: 55 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
sudo apt-get install libasound2-dev
<br />
<p align="center">
<h3 align="center">deno_audio</h3>

<p align="center">
Audio playback library for Deno.
</p>
<p align="center">

[![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)

</p>
</p>

<!-- TODO: will CPAL WASM really work on Deno?
> Currently published as a Deno Plugin until Rodio supports WASM. [RustAudio/rodio#313](https://github.com/RustAudio/rodio/issues/313)
--->

## Example

```typescript
import { play } from "https://deno.land/[email protected]/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.

0 comments on commit 4191771

Please sign in to comment.