From: Paul Brossier <piem@piem.org>
Date: Fri, 3 Feb 2017 20:05:23 +0000 (+0100)
Subject: README.md: improve basic description
X-Git-Tag: v0.0.2~2
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=c715466ee01cd9e5681326c89cfa15bea2ecf9ee;p=node-aubio.git

README.md: improve basic description
---

diff --git a/README.md b/README.md
index 8171e9c..f8f5a9e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
 # node-aubio
-Node.js bindings for [aubio](https://aubio.org), a library for audio labeling: pitch, onset, tempo tracking, and more
+
+Node.js bindings for [aubio][aubio], a library for audio and music analysis,
+synthesis, and effects. aubio features include pitch tracking, onset detectin,
+beat tracking (tempo), phase vocoder, biquad and IIR filters.
+
+In order to use this module, you will need to have [aubio][aubio] installed on
+your system. See [aubio's download page][aubio-download] to find out how to get
+aubio for your system.
+
+node-aubio uses [ffi][ffi] to load aubio's dynamic library and use directly the
+aubio functions as well as [ref][ref] to access C pointers efficiently. To find
+out more about [ffi][ffi] and [ref][ref], read the [Node FFI
+Tutorial](https://github.com/node-ffi/node-ffi/wiki/Node-FFI-Tutorial).
+
+[aubio]: https://aubio.org
+[aubio-download]: https://aubio.org/download
+[ffi]: https://github.com/node-ffi/node-ffi/wiki/Node-FFI-Tutorial
+[ref]: https://github.com/TooTallNate/ref