diff --git a/README.md b/README.md new file mode 100644 index 000000000..fb891cf77 --- /dev/null +++ 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 deleted file mode 100644 index e69de29bb..000000000