Merge pull request #31 from VisLab/main

Added CHANGELOG and minor updates to README and docs

CHANGELOG.md

@@ -0,0 +1,13 @@
+## Release 1.0.0 August 3, 2024 - Initial release
+
+- Implements a base class `HedTools` with following interface:
+  - `generateSidecar`
+  - `getHedAnnotations`
+  - `searchHed
+  - `validateEvents`
+  - `validateSidecar`
+  - `validateTags`
+  - `resetHedVersion`
+- Provides two implementations of the interface:
+  - `HedToolsService` - calls web services to perform the operations
+  - `HedToolsPython` - calls local installed Python libraries to perform the operations

README.md

@@ -1,4 +1,5 @@
 [![Documentation Status](https://readthedocs.org/projects/hed-matlab/badge/?version=latest)](https://www.hed-matlab.org/en/latest/?badge=latest)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13201057.svg)](https://doi.org/10.5281/zenodo.13201057)
 
 # HED-MATLAB
 This repository contains the MATLAB supporting code infrastructure 

docs/source/index.rst

@@ -7,19 +7,17 @@ Hierarchical Event Descriptor (HED) MATLAB Tools
 
 .. sidebar:: **Links**
 
-   * `PDF docs <https://hed-matlab.readthedocs.io/_/downloads/en/latest/pdf/>`_
+   * `API docs <https://hed-matlab.readthedocs.io/_/downloads/en/latest/pdf/>`_
 
    * `Source code <https://github.com/hed-standard/hed-matlab/>`_
 
-Note:  this is a work in progress. More information is coming.
 
 .. toctree::
    :maxdepth: 6
    :caption: Contents:
 
    introduction.md
-   user_guide.rst
-
+
 .. toctree::
    :maxdepth: 6
    :caption: HED MATLAB API:

docs/source/introduction.rst

@@ -19,20 +19,10 @@ Why HED?
    so that tools can automatically use this information in analysis.
 
 For more information on using Hierarchical Event Descriptors (HED)
-visit `HED examples <https://hed-examples.readthedocs.io/en/latest/index.html>`_:
+visit the `HED homepage` <https://www.hedtags.org>`_:
+and the `HED resources page <https://www.hed-resources.org/en/latest/HedMatlabTools.html>`_:
 
 
-Installing hedtools
-===================
-Hedtools will be available soon on pypi, but in the meantime,
-you can install directly from the
-`GitHub repository <https://github.com/hed-standard/hed-python>`_
-using the following command:
-
-```code
->>> pip install git+https://github.com/hed-standard/hed-python.git
-```
-
 Finding help
 ============
 
@@ -44,7 +34,7 @@ Finding help
 
 
 :Issues and problems:
-    * If you notice a bug in the python hedtools code or encounter other problems using the tools, please `open an issue`_ in the
-      hed-python repository on github.
+    * If you notice a bug in the HED tools for matlab code or encounter other problems using the tools, please `open an issue`_ in the
+      hed-matlab repository on github.
 
-.. _open an issue: https://github.com/hed-standard/hed-python/issues
+.. _open an issue: https://github.com/hed-standard/hed-matlab/issues