From a31e7e84780ce98b33bb450670eb893c417296b2 Mon Sep 17 00:00:00 2001 From: Chris Flerin Date: Thu, 6 May 2021 12:09:50 +0200 Subject: [PATCH] Update readme --- .github/workflows/ci.yml | 2 +- CHANGELOG.rst | 2 +- README.rst | 16 ++++++++++++++++ 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 1d030a1..b4907f0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: Python Package Workflow +name: build on: push: diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ab712db..4073d71 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,5 +6,5 @@ Change Log Version History --------------- -0.0.1 +0.1.0 * Project created. diff --git a/README.rst b/README.rst index 89f83cc..04731e6 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,8 @@ ctxcore ####### +|ctxcore|_ |buildstatus|_ |pypipackage|_ |docstatus|_ + Core functions for pycisTarget and the SCENIC tool suite @@ -23,3 +25,17 @@ Here is a simple example: # Fill this section in with the common use-case. The `API Reference `_ provides API-level documentation. + +.. |ctxcore| image:: https://img.shields.io/github/v/release/aertslab/ctxcore + :target: https://github.com/aertslab/ctxcore/releases + :alt: GitHub release (latest by date) + +.. |buildstatus| image:: https://github.com/aertslab/ctxcore/actions/workflows/ci.yml/badge.svg +.. _buildstatus: https://github.com/aertslab/ctxcore/actions + +.. |pypipackage| image:: https://img.shields.io/pypi/v/ctxcore?color=%23026aab +.. _pypipackage: https://pypi.org/project/ctxcore/ + +.. |docstatus| image:: https://readthedocs.org/projects/ctxcore/badge/?version=latest +.. _docstatus: https://ctxcore.readthedocs.io/en/latest/?badge=latest +