diff README.md @ 2:edee860b9f61

First release on Github

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Thu Sep 17 22:01:30 2015 +0200
@@ -0,0 +1,42 @@
+AUDIo TOKenizer
+===============
+
+`auditok` is an Audio Activity Detection library that wan be used with online data (i.e. microphone) or with audio files.
+
+Requirements
+------------
+`auditok` uses [PyAudio](http://people.csail.mit.edu/hubert/pyaudio/) for audio acquisition and playback.
+If installed, numpy  will be privileged for math operations on vectors.
+
+Installation
+------------
+    pip install auditok
+
+Demos
+-----
+This code reads data from the microphone and plays back whatever it detects.
+    python demos/echo.py
+
+`echo.py` accepts two arguments: energy threshold (default=45) and duration in seconds (default=10):
+
+    python demos/echo.py 50 15
+
+   If only one argument is given it will be used for energy. Other demos are in /demos.
+
+Documentation
+-------------
+
+Check out  a quick start and the API documentation [here](http://amsehili.github.io/auditok/pdoc/)
+
+Contribution
+------------
+Contributions are very appreciated !
+
+License
+-------
+`auditok` is published under the GNU General Public License Version 3.
+
+Author
+------
+Amine Sehili (<[e-mail]>)
+