DOC Update README before pushing qipype

spinicist · Jun 26, 2020 · 437fb82 · 437fb82
1 parent 9b86868
commit 437fb82
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 205 deletions.
diff --git a/Python/T1_mapping.ipynb → Python/Notebooks/T1_mapping.ipynb b/Python/T1_mapping.ipynb → Python/Notebooks/T1_mapping.ipynb
diff --git a/Python/example_notebook.ipynb b/Python/example_notebook.ipynb
diff --git a/Python/setup.py b/Python/setup.py
@@ -13,7 +13,7 @@
 
 setup(
     name='qipype',
-    version='1.0',
+    version='0.1',
     description='nipype interfaces to QUantitative Imaging Tools',
     long_description=long_description,
     long_description_content_type="text/markdown",

diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ in the documentation.
 
 ### Python
 
-QUIT now comes with `nipype` wrappers. Install with `pip install QUIT`.
+QUIT now comes with `nipype` wrappers. Install with `pip install qipype`.
 
 ## Usage
 
@@ -61,11 +61,9 @@ of commands require an input 4D Nifti file containing the image data to fit,
 and a `.json` file containing the sequence parameters (e.g. `TR`). See 
 examples for each command at http://quit.readthedocs.io.
 
-For the `nipype` wrappers, there are example iPython notebooks available in this 
-directory https://github.com/spinicist/QUIT/blob/master/Python/. You can 
-download the one for T1 mapping here https://github.com/spinicist/QUIT/raw/master/Python/T1_mapping.ipynb.
-Alternatively, look at the example workflows for CEST and MPM to see how to 
-build a complete pipeline.
+There is an example iPython notebooks available in this 
+directory https://mybinder.org/v2/gh/spinicist/QUIT/master?filepath=Python%2FNotebooks%2FT1_mapping.ipynb.
+Workflows for CEST and MPM are provided in `qipype.workflows`.
 
 ## Getting Help