update documentation

slhck · Feb 8, 2016 · 78a202f · 78a202f
1 parent 2354c0b
commit 78a202f
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 18 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,6 +3,12 @@
 History
 -------
 
+0.2.1 (2016-02-08)
+__________________
+
+* Documentation fixes
+
+
 0.2.0 (2016-02-08)
 __________________
 

diff --git a/README.rst b/README.rst
@@ -1,23 +1,26 @@
 ffmpeg-normalize
 ================
 
-ffmpeg / avconv macro for normalizing audio
+ffmpeg script for normalizing audio.
 
-Audio normalization script, normalizing media files to WAV output
-
-This program normalizes audio to a certain dB level. The default is an
+This program normalizes media files to a certain dB level. The default is an
 RMS-based normalization where the mean is lifted. Peak normalization is
-possible with the -m –max option.
+possible with the ``-m`` option.
 
 It takes any audio or video file as input, and writes the audio part as
 output WAV file. The normalized audio can also be merged with the
 original.
 
-Installation:
+Requirements:
+
+- Python 2.7 (Python 3 is not supported yet)
+- ffmpeg from http://ffmpeg.org/ installed in your $PATH
+
+Installation::
 
     pip install ffmpeg-normalize
 
-Usage:
+Usage::
 
     ffmpeg-normalize [options] <input-file>...
 
@@ -44,7 +47,7 @@ Options:
 -  ``-e``, ``--extra-options <extra-options>`` — Set extra options
    passed to ffmpeg (e.g. “-b:a 192k” to set audio bitrate)
 
-Examples:
+Examples::
 
     ffmpeg-normalize -v file.mp3
     ffmpeg-normalize -v *.avi

diff --git a/ffmpeg_normalize/__init__.py b/ffmpeg_normalize/__init__.py
@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "0.2.1"
diff --git a/ffmpeg_normalize/__main__.py b/ffmpeg_normalize/__main__.py
@@ -1,17 +1,16 @@
 #!/usr/bin/env python
 """
-ffmpeg-normalize 0.2.0
+ffmpeg-normalize 0.2.1
 
-ffmpeg / avconv macro for normalizing audio
+ffmpeg script for normalizing audio.
 
-Audio normalization script, normalizing media files to WAV output
+This program normalizes media files to a certain dB level. The default is an
+RMS-based normalization where the mean is lifted. Peak normalization is
+possible with the -m option.
 
-This program normalizes audio to a certain dB level. The default is an RMS-based
-normalization where the mean is lifted. Peak normalization is possible with the -m --max
-option.
-
-It takes any audio or video file as input, and writes the audio part as output WAV file.
-The normalized audio can also be merged with the original.
+It takes any audio or video file as input, and writes the audio part as
+output WAV file. The normalized audio can also be merged with the
+original.
 
 Usage:
   ffmpeg-normalize [options] <input-file>...