Add readme.rst

Author: bobleesj

LICENSE.txt

@@ -15,8 +15,8 @@
 .. |Black| image:: https://img.shields.io/badge/code_style-black-black
         :target: https://github.com/psf/black
 
-.. |CI| image:: https://github.com/diffpy/diffpy.nmf_mapping/actions/workflows/main.yml/badge.svg
-        :target: https://github.com/diffpy/diffpy.nmf_mapping/actions/workflows/main.yml
+.. |CI| image:: https://github.com/diffpy/diffpy.nmf_mapping/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
+        :target: https://github.com/diffpy/diffpy.nmf_mapping/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
 
 .. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.nmf_mapping/branch/main/graph/badge.svg
         :target: https://codecov.io/gh/diffpy/diffpy.nmf_mapping
@@ -35,7 +35,7 @@
 .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
         :target: https://github.com/diffpy/diffpy.nmf_mapping/issues
 
-Run NMF analysis on PDF and XRD data
+Python package for running NMF analysis on PDF and XRD data.
 
 * LONGER DESCRIPTION HERE
 
@@ -74,20 +74,18 @@ To add "conda-forge" to the conda channels, run the following in a terminal. ::
 We want to install our packages in a suitable conda environment.
 The following creates and activates a new environment named ``diffpy.nmf_mapping_env`` ::
 
-        conda create -n diffpy.nmf_mapping_env python=3
+        conda create -n diffpy.nmf_mapping_env diffpy.nmf_mapping
         conda activate diffpy.nmf_mapping_env
 
-Then, to fully install ``diffpy.nmf_mapping`` in our active environment, run ::
+To confirm that the installation was successful, type ::
 
-        conda install diffpy.nmf_mapping
+        python -c "import diffpy.nmf_mapping; print(diffpy.nmf_mapping.__version__)"
 
-Another option is to use ``pip`` to download and install the latest release from
-`Python Package Index <https://pypi.python.org>`_.
-To install using ``pip`` into your ``diffpy.nmf_mapping_env`` environment, we will also have to install dependencies ::
-
-        pip install -r https://raw.githubusercontent.com/diffpy/diffpy.nmf_mapping/main/requirements/run.txt
+The output should print the latest version displayed on the badges above.
 
-and then install the package ::
+If the above does not work, you can use ``pip`` to download and install the latest release from
+`Python Package Index <https://pypi.python.org>`_.
+To install using ``pip`` into your ``diffpy.nmf_mapping_env`` environment, type ::
 
         pip install diffpy.nmf_mapping
 
@@ -97,6 +95,11 @@ and run the following ::
 
         pip install .
 
+Getting Started
+---------------
+
+You may consult our `online documentation <https://diffpy.github.io/diffpy.nmf_mapping>`_ for tutorials and API references.
+
 Support and Contribute
 ----------------------
 
@@ -125,7 +128,7 @@ trying to commit again.
 
 Improvements and fixes are always appreciated.
 
-Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.nmf_mapping/blob/main/CODE_OF_CONDUCT.rst>`_.
+Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.nmf_mapping/blob/main/CODE_OF_CONDUCT.rst>`_.
 
 Contact
 -------