diff --git a/README.md b/README.md index 34e1a1b..48f0340 100644 --- a/README.md +++ b/README.md @@ -24,14 +24,14 @@ [pypi]: https://pypi.org/project/cherab-imas/ [pypi-badge]: https://img.shields.io/pypi/v/cherab-imas?label=PyPI&logo=pypi&logoColor=gold&style=flat-square [pypi-publish]: https://github.com/cherab/imas/actions/workflows/deploy-pypi.yml -[pypi-publish-badge]: https://img.shields.io/github/actions/workflow/status/cherab/imas/deploy-pypi.yml?style=flat-square&label=PyPI%20Publish&logo=github +[pypi-publish-badge]: https://img.shields.io/github/actions/workflow/status/cherab/imas/deploy-pypi.yml?event=release&style=flat-square&logo=github&label=PyPI%20Publish [python-badge]: https://img.shields.io/pypi/pyversions/cherab-imas?logo=Python&logoColor=gold&style=flat-square --- -`cherab` add-on module for IMAS (Integrated Modelling & Analysis Suite). +[`cherab`](https://github.com/cherab/core) add-on module for **IMAS** (Integrated Modelling & Analysis Suite). -This module enables the creation of `cherab`'s functional objects (e.g. plasma, observers, meshes, etc.) from IMAS IDS (Interface Data Structures). +This module enables the creation of `cherab`'s functional objects (e.g. plasma, observers, meshes, etc.) from IMAS IDSs (Interface Data Structures). diff --git a/docs/source/intro.md b/docs/source/intro.md index b41db3c..4caaae0 100644 --- a/docs/source/intro.md +++ b/docs/source/intro.md @@ -2,7 +2,7 @@ # 🚀 Get Started -This page gives a quick overview of how to get started with `cherab-imas`, and how to use it within Docutils and Sphinx. +This page gives a quick overview of how to get started with `cherab-imas`, including installation instructions and a simple example script. ## Installation