Skip to content

Commit

Permalink
add badge & minor rst updates
Browse files Browse the repository at this point in the history
  • Loading branch information
whitews committed Mar 29, 2024
1 parent 0648a8d commit c4f503c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
[![Test (develop)](https://github.com/whitews/FlowIO/actions/workflows/tests_develop.yml/badge.svg)](https://github.com/whitews/FlowIO/actions/workflows/tests_develop.yml)
[![Coverage](https://codecov.io/gh/whitews/FlowIO/branch/master/graph/badge.svg)](https://codecov.io/gh/whitews/flowio)
[![Documentation Status](https://readthedocs.org/projects/flowio/badge/?version=latest)](https://flowio.readthedocs.io/en/latest/?badge=latest)
![PyPI - Downloads](https://img.shields.io/pypi/dm/flowio)

## Overview

Expand Down
17 changes: 10 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ FlowIO Documentation
.. image:: https://img.shields.io/pypi/pyversions/flowio.svg
:target: https://pypi.org/project/flowio/

.. image:: https://img.shields.io/pypi/dm/flowio
:alt: PyPI - Downloads

FlowIO is a Python library for reading / writing Flow Cytometry Standard (FCS)
files, with zero external dependencies and is compatible with Python 3.7+.

Expand All @@ -38,29 +41,29 @@ FlowJo 10 support, see the related FlowKit_ project.

.. _FlowKit: https://github.com/whitews/FlowKit

Changelogs
__________

`Changelogs for versions are available here <https://github.com/whitews/FlowIO/releases>`_

Installation
------------

The recommended way to install FlowIO is via the `pip` command:

.. code-block:: python
.. code-block::
pip install flowio
Or, if you prefer, you can install from the GitHub source:

.. code-block:: python
.. code-block::
git clone https://github.com/whitews/flowio
cd flowio
pip install .
Changelogs
__________

`Changelogs for versions are available here <https://github.com/whitews/FlowIO/releases>`_

----

API
Expand Down

0 comments on commit c4f503c

Please sign in to comment.