diff README.rst @ 14:628f82e72d72

Version as released on PyPI 0.1.0
author Vimalkumar Velayudhan <vimal@biotechcoder.com>
date Wed, 26 Aug 2015 16:37:10 +0100
parents 096c6bbf4a04
children b78a5ba760b1
line wrap: on
line diff
--- a/README.rst	Fri Aug 21 12:37:54 2015 +0100
+++ b/README.rst	Wed Aug 26 16:37:10 2015 +0100
@@ -1,1 +1,28 @@
-docs/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 :ref:`usage`.
+
+
+Free software: GPL license.
+
+Documentation: https://riboplot.readthedocs.org.
+