Added link to documentaiton and prereleased as type of trigger for gi…

…thub actions to move this package to TestPyPI
TheJacksonLaboratory · Oct 2, 2023 · 6cf4002 · 6cf4002
1 parent a7f0a3a
commit 6cf4002
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/.github/workflows/putblish_to_test_pypi.yml b/.github/workflows/putblish_to_test_pypi.yml
@@ -2,7 +2,7 @@ name: Release to Test PyPI
 
 on:
   release:
-    types: [released]
+    types: [prereleased]
 
 jobs:
   release:

diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ my_dataset = zds.ZarrDataset(...,
                              patch_sampler=my_patch_sampler)
 ```
 
-Examples of integration of the **ZarrDataset** class with the PyTorch's **DataLoader** can be found in the documentation.
+Examples of integration of the **ZarrDataset** class with the PyTorch's **DataLoader** can be found in the (documentation)[https://thejacksonlaboratory.github.io/zarrdataset/index.html].
 
 ## Installation
 To install this package and have access to the zarr-based PyTorch Dataset and other functionalities, clone this repository and use the following command from inside the cloned repository location.