diff docs/readme.rst @ 7:096c6bbf4a04

Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments

--- a/docs/readme.rst	Wed Aug 12 16:28:43 2015 +0100
+++ b/docs/readme.rst	Thu Aug 13 15:03:20 2015 +0100
@@ -1,1 +1,28 @@
-../README.rst
\ No newline at end of file
+===============================
+RiboPlot
+===============================
+
+.. image:: https://img.shields.io/travis/vimalkumarvelayudhan/riboplot.svg
+        :target: https://travis-ci.org/vimalkumarvelayudhan/riboplot
+
+.. image:: https://img.shields.io/pypi/v/riboplot.svg
+        :target: https://pypi.python.org/pypi/riboplot
+
+
+RiboPlot includes programs to plot and output Ribo-Seq read counts from an alignment file (BAM format).
+
+There are two programs in the package:
+
+**riboplot**
+    Plot and output read counts (csv) for a single transcript.
+
+**ribocount**
+    Output read counts for all transcripts in an alignment.
+
+For help on using these programs, please refer to :doc:`usage`.
+
+
+Free software: BSD license.
+
+Documentation: https://riboplot.readthedocs.org.
+