From 41917712e5378d9a7c3c18157249023920ec84dc Mon Sep 17 00:00:00 2001
From: divy-work <dj.srivastava23@gmail.com>
Date: Tue, 3 Nov 2020 17:02:37 +0530
Subject: [PATCH] chores(docs): add README

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

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
+<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/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.