updating docs, in progress

data-exp-lab · Aug 2, 2023 · eea418c · eea418c
1 parent 9f5ca55
commit eea418c
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 3 deletions.
diff --git a/.napari/DESCRIPTION.md b/.napari/DESCRIPTION.md
@@ -89,4 +89,8 @@ Many plugins may be used in the course of published (or publishable) research, a
 during conference talks and other public facing events. If you'd like to be cited in
 a particular format, or have a DOI you'd like used, you should provide that information here. -->
 
-yt-napari provides plugins to help load data from [yt](https://yt-project.org/) into napari. It includes a graphical data loader, json-based file loading and helper-functions for jupyter notebook interaction. See the [full documentation](https://yt-napari.readthedocs.io) for more details.
+yt-napari provides plugins to help load data from [yt](https://yt-project.org/) into napari. It includes a graphical data loader, json-based file loading and helper-functions for jupyter notebook interaction.
+
+![](https://raw.githubusercontent.com/data-exp-lab/yt-napari/main/docs/_static/nb_iso_galaxy_T_rho.png)
+
+See the [full documentation](https://yt-napari.readthedocs.io) for more details.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,3 +1,6 @@
+## v0.2.0
+
+
 ## v0.1.0
 
 Changes
diff --git a/README.md b/README.md
@@ -101,11 +101,11 @@ nbscreenshot(viewer)
 
 #### using the yt Reader plugin
 
-To use the yt Reader plugin, click on `Plugins -> yt-napari: yt Reader`. Select a file, specify a field type and field, set the region to sample and then simply click "Load":
+To use the yt Reader plugin, click on `Plugins -> yt-napari: yt Reader`. From there, add a region or slice selector then specify a field type and field and bounds to sample  between and then simply click "Load":
 
 ![Loading a subset of a yt dataset from the napari viewer](./assets/images/readme_ex_003_gui_reader.gif)
 
-To load a different field or section, adjust the values and click "Load" again.
+You can add multiple selections and load them all at once or adjust values and click "Load" again.
 
 #### using a json file and schema
 

diff --git a/assets/images/readme_ex_003_gui_reader.gif b/assets/images/readme_ex_003_gui_reader.gif
diff --git a/docs/_static/nb_iso_galaxy_T_rho.png b/docs/_static/nb_iso_galaxy_T_rho.png
diff --git a/docs/_static/readme_ex_003_gui_reader.gif b/docs/_static/readme_ex_003_gui_reader.gif
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,6 +8,8 @@ Welcome to yt-napari's documentation!
 
 :code:`yt-napari` is a suite of plugins and methods for loading data from :code:`yt` in :code:`napari`. For issues and notes on contributing, see the `github repository <https://github.com/data-exp-lab/yt-napari>`_.
 
+.. image:: _static/readme_ex_003_gui_reader.gif
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: