Merge pull request #150 from aidh-ms/issue/27-add-docs

add doc link in readme

Author: Paul-B98

README.md

@@ -7,6 +7,8 @@ Python package to detect AKI within time series data.
 The goal of this package is to establish well tested, comprehensive functions for the detection of Acute Kidney Injury (AKI) in time series data, according to the Kidney Disease Improving Global Outcomes (KDIGO) Criteria, established in 2012 [^kdigo].
 ![](doc/doc/img/kdigo_criteria.png)
 
+For more information, see the [documentation](https://aidh-ms.github.io/pyAKI/).
+
 ## Installation
 
 You can install the pyAKI package from PyPI or from source.

docs/docs/index.md

@@ -1,7 +1,7 @@
 # pyAKI
 
 <p style="text-align:center;" markdown="1">
-_A Python package to detect AKI within time series data._
+_A Python package to detect AKI within time series data._ <br>
 [![Coverage Status](https://coveralls.io/repos/github/aidh-ms/pyAKI/badge.svg?branch=main)](https://coveralls.io/github/aidh-ms/pyAKI?branch=main)
 </p>