diff README.rst @ 336:0e13ef3598f3

Update README
    - Use rst instead or markdown

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Sat Oct 26 18:23:52 2019 +0100
@@ -0,0 +1,31 @@
+.. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
+    :target: https://travis-ci.org/amsehili/auditok
+
+.. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
+    :target: http://auditok.readthedocs.org/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. code:: python
+
+    from auditok import split
+    audio_regions = split("audio.wav")
+    for region in audio_regions:
+        region.play(progress_bar=True)
+        filename = region.save("/tmp/region_{meta.start:.3f}.wav")
+        print("region saved as: {}".format(filename))
+
+
+
+``auditok`` is an **Audio Activity Detection** tool that can process online data (read from an audio device or from standard input) as well as audio files. It can be used as a command line program and offers an easy to use API.
+
+
+.. code:: python
+
+    from auditok import AudioRegion
+    region = AudioRegion.load("audio.wav")
+    regions = region.split_and_plot()
+
+
+ouptut figure:
+
+.. image:: doc/figures/example_1.png