Update readme

aertslab · May 6, 2021 · a31e7e8 · a31e7e8
1 parent 761af91
commit a31e7e8
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git 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
@@ -6,5 +6,5 @@ Change Log
 Version History
 ---------------
 
-0.0.1
+0.1.0
     * Project created.
diff --git 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 <http://ctxcore.readthedocs.io>`_ 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
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,5 +6,5 @@ Change Log @@
     Version History
     ---------------
-.0.1
+.1.0
         * Project created.