From: Thomas Fillon <thomas@parisson.com>
Date: Mon, 12 Jan 2015 14:44:38 +0000 (+0100)
Subject: Update README
X-Git-Tag: 0.7^2~30^2~1
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=c1895d3477a3a65e76f397c82d60cc56279f5a4e;p=timeside.git

Update README
---

diff --git a/README.rst b/README.rst
index a6af65c..95d1054 100644
--- a/README.rst
+++ b/README.rst
@@ -60,15 +60,15 @@ Dive in
 
 To list all available plugins::
 
- import timeside
+ import timeside.core
  timeside.core.list_processors()
 
 Define some processors::
 
  from timeside.core import get_processor
  decoder  =  get_processor('file_decoder')('sweep.wav')
- grapher  =  get_processor('waveform_simple')
- analyzer =  get_processor('level')
+ grapher  =  get_processor('waveform_simple')()
+ analyzer =  get_processor('level')()
  encoder  =  get_processor('vorbis_encoder')('sweep.ogg')
 
 Then run the *magic* pipeline::
@@ -91,6 +91,16 @@ For more extensive examples, please see the `full documentation <http://files.pa
 News
 =====
 
+0.7
+
+ * Code refactoring:
+
+   - Create a new module `timeside.plugins` and move processors therein: timeside.plugins.decodr, timeside.plugins.analyzer, timeside.plugins.encoder, timeside.plugins.fx
+   - `timeside.plugins` is a `namespace package <https://pythonhosted.org/setuptools/setuptools.html#namespace-packages>`_ enabling external plugins to be automatically plug into TimeSide (see for example `timeside-diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_).
+   - To properly manage the namespace packages structure, the TimeSide main module is now `timeside.core` and code should now be initialized with `import timeside.core`.
+ * Move all analyzers developped by the partners of the Diadems project to a new repository: `timeside-diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_
+
+
 0.6.1
 
   * Fix various minor bugs