Add README.md

hyperspy · Oct 29, 2023 · 6efda99 · 6efda99
1 parent 801a678
commit 6efda99
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+
+**exSpy** is a Python package extending the functionality for multi-dimensional
+data analysis provided by the [HyperSpy](https://hyperspy.org) library. It is
+aimed at helping with the analysis of X-rays Energy Dispersive Spectroscopy (EDS)
+and Electron Energy Loss Spectroscopy (EELS).
+
+Go to the documentation for instructions on how to install exSpy and start an
+analysis: [Read the docs](https://exspy.readthedocs.io).
+
+Everyone is welcome to contribute. Please read our
+[contributing guidelines](https://github.com/hyperspy/exspy/blob/main/CONTRIBUTING.rst) and get started!
+
+Development of exSpy is documented in the
+[changelog](https://github.com/hyperspy/exspy/blob/main/CHANGES.rst).
diff --git a/README.rst b/README.rst