Changing README to rst file.

tmcclintock · Nov 21, 2019 · d2ab5a8 · d2ab5a8
1 parent f3afeda
commit d2ab5a8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,8 @@
+Cluster Toolkit
+===============
+
+This repository contains routines used in the Dark Energy Survey Year 1 stacked cluster weak lensing analysis. These routines form the basis of the model of cluster lensing profiles.
+
+If you have any questions feel free to get in contact or consult `the documentation <http://cluster-toolkit.readthedocs.io/en/latest/>`_.
+
+Note: the toolkit should be considered in beta. The API is subject to change and some failure modes may exist for extreme models.