Skip to content

Commit

Permalink
Update README.rst as long description
Browse files Browse the repository at this point in the history
  • Loading branch information
JannesSP committed Jul 12, 2023
1 parent a2c820f commit 03f5b14
Showing 1 changed file with 2 additions and 31 deletions.
33 changes: 2 additions & 31 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
|Alt text|
==========

Read5 is a python wrapper to read fast5, slow5/blow5 and pod5 files
using the same overloaded functions from different APIs.

|License: GPL v3| |Python3|

|PyPI version|

.. raw:: html

<!-- ![conda](https://img.shields.io/badge/Uses-conda-green.svg) [![Anaconda-Server Badge](https://anaconda.org/jannessp/read5/badges/version.svg)](https://anaconda.org/jannessp/read5) ![Conda](https://img.shields.io/conda/dn/jannessp/read5) [![Conda package](https://anaconda.org/jannessp/read5/badges/latest_release_date.svg)](https://anaconda.org/jannessp/read5) [![Conda package](https://anaconda.org/jannessp/read5/badges/platforms.svg)](https://anaconda.org/jannessp/read5) -->

|DOI|

|Twitter Follow| **## Table of Content
1.\ **\ `Installation <#installation>`__\ **\ 2.\ **\ `Usage <#usage>`__\ **\ 3.\ **\ `Full
Documentation <https://jannessp.github.io/read5.github.io/>`__ ##
Installation
------------

Pod5 is not available via conda (27.06.2023). Read5 Currently available
via pipy.
Expand Down Expand Up @@ -66,15 +48,4 @@ Full Documentation
------------------

Created with `pdoc3 <https://pdoc3.github.io/pdoc/>`__. Can be found
`here <https://jannessp.github.io/read5.github.io/>`__.

.. |Alt text| image:: figures/logo.png
.. |License: GPL v3| image:: https://img.shields.io/badge/License-GPL%20v3-teal.svg
:target: https://www.gnu.org/licenses/gpl-3.0
.. |Python3| image:: https://img.shields.io/badge/Language-Python_3-darkred.svg
.. |PyPI version| image:: https://badge.fury.io/py/read5.svg
:target: https://badge.fury.io/py/read5
.. |DOI| image:: https://zenodo.org/badge/633012569.svg
:target: https://zenodo.org/badge/latestdoi/633012569
.. |Twitter Follow| image:: https://img.shields.io/twitter/follow/Ja_Spangenberg
:target: https://twitter.com/Ja_Spangenberg
`here <https://jannessp.github.io/read5.github.io/>`__.

0 comments on commit 03f5b14

Please sign in to comment.