Merge branch 'dev' into element-dlc-test

.github/workflows/release.yaml

@@ -24,4 +24,4 @@ jobs:
     uses: datajoint/.github/.github/workflows/devcontainer-publish.yaml@main
     secrets:
       DOCKERHUB_USERNAME: ${{secrets.DOCKERHUB_USERNAME}}
-      DOCKERHUB_TOKEN: ${{secrets.DOCKERHUB_TOKEN_FOR_ELEMENTS}}
+      DOCKERHUB_TOKEN: ${{secrets.DOCKERHUB_TOKEN_FOR_ELEMENTS}}

.github/workflows/test.yaml

@@ -34,4 +34,3 @@ jobs:
           python_version=${{matrix.py_ver}}
           black element_deeplabcut --check --verbose --target-version py${python_version//.}
           black notebooks --check --verbose --target-version py${python_version//.}
-

CHANGELOG.md

@@ -3,6 +3,11 @@
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and 
 [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [0.2.8] - 2023-08-07
+
++ Update - GitHub Actions with new reusable workflows
++ Update - Readme instructions
+
 ## [0.2.7] - 2023-08-04
 
 + Fix - Update the project path in the pose config file to train the model
@@ -72,6 +77,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
   graciously provided by the Mathis Lab.
 + Add - Support for 2d single-animal models
 
+[0.2.8]: https://github.com/datajoint/element-deeplabcut/releases/tag/0.2.8
 [0.2.7]: https://github.com/datajoint/element-deeplabcut/releases/tag/0.2.7
 [0.2.6]: https://github.com/datajoint/element-deeplabcut/releases/tag/0.2.6
 [0.2.5]: https://github.com/datajoint/element-deeplabcut/releases/tag/0.2.5

README.md

@@ -1,4 +1,6 @@
-# DataJoint Element - DeepLabCut
+[![PyPI version](https://badge.fury.io/py/element-deeplabcut.svg)](http://badge.fury.io/py/element-deeplabcut)
+
+# DataJoint Element for Pose Estimation with DeepLabCut
 
 DataJoint Element for markerless pose estimation with
 [DeepLabCut](https://www.deeplabcut.org/).  DataJoint Elements collectively standardize
@@ -23,3 +25,28 @@ Installation and usage instructions can be found at the
 [Element documentation](https://datajoint.com/docs/elements/element-deeplabcut).
 
 ![element-deeplabcut diagram](https://raw.githubusercontent.com/datajoint/element-deeplabcut/main/images/diagram_dlc.svg)
+
+## Experiment Flowchart
+
+![flowchart](https://raw.githubusercontent.com/datajoint/element-deeplabcut/main/images/flowchart.svg)
+
+## Data Pipeline Diagram
+
+![pipeline](https://raw.githubusercontent.com/datajoint/element-deeplabcut/main/images/pipeline.svg)
+
+## Getting Started
+
++ Install from PyPI
+
+     ```bash
+     pip install element-deeplabcut
+     ```
+
++ [Interactive tutorial](https://github.com/datajoint/workflow-deeplabcut)
+
++ [Documentation](https://datajoint.com/docs/elements/element-deeplabcut)
+
+## Support
+
++ If you need help getting started or run into any errors, please open a GitHub Issue 
+or contact our team by email at [email protected].

element_deeplabcut/version.py

@@ -1,4 +1,4 @@
 """
 Package metadata
 """
-__version__ = "0.2.7"
+__version__ = "0.2.8"