Skip to content

Commit 5fd69e6

Browse files
committed
Added links to documentation and binder
1 parent 6ca3e79 commit 5fd69e6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Python CI](https://github.com/alexdaniel654/qlayers/actions/workflows/python_ci.yml/badge.svg?branch=main)](https://github.com/alexdaniel654/qlayers/actions/workflows/python_ci.yml)
44
[![codecov](https://codecov.io/gh/alexdaniel654/qlayers/graph/badge.svg?token=06FRSZ02SJ)](https://codecov.io/gh/alexdaniel654/qlayers)
55
[![Documentation Status](https://readthedocs.org/projects/qlayers/badge/?version=latest)](https://qlayers.readthedocs.io/latest/)
6+
[![Binder](https://terrarium.evidencepub.io/badge_logo.svg)](https://terrarium.evidencepub.io/v2/gh/alexdaniel654/qlayers/HEAD)
67
[![PyPI version](https://badge.fury.io/py/qlayers.svg)](https://badge.fury.io/py/qlayers)
78
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/qlayers/badges/version.svg)](https://anaconda.org/conda-forge/qlayers)
89
[![Downloads](https://static.pepy.tech/badge/qlayers)](https://pepy.tech/project/qlayers)
@@ -38,8 +39,11 @@ pip install -e .
3839

3940
## Quick Start
4041

41-
For a more thorough example of how to use `qlayers` see the tutorials section of this reposetry/documentation, however if
42-
you want to get started, the snippet of code below should get you going.
42+
Documentation for `qlayers` can be found [here](https://qlayers.readthedocs.io/latest/). This includes a full API
43+
reference, tutorials and examples of how to use `qlayers` to generate layers and apply them to quantitative maps.
44+
The tutorials can also be run through [binder](https://terrarium.evidencepub.io/v2/gh/alexdaniel654/qlayers/HEAD) if
45+
you want to have a go with `qlayers` without installing anything. However, if you want to get started on your machine
46+
with the minimum lines of code, the snippet of code below should get you going.
4347

4448
```python
4549
import nibabel as nib

0 commit comments

Comments
 (0)