Merge branch 'readme-updates'

1 files changed, 39 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..44260cc
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+
+Emacs support for Snakemake
+===========================
+
+This repo contains two Emacs libraries for Snakemake [^1].
+
+  * snakemake-mode.el provides a major mode for editing Snakemake
+    files.
+
+  * snakemake.el defines a popup interface for calling Snakemake.
+
+See the header of each file for more information.
+
+Both of these are available on MELPA under the snakemake-mode package:
+
+  https://melpa.org/#/snakemake-mode
+
+[^1]: https://snakemake.readthedocs.io/en/stable/
+
+
+Contributing
+------------
+
+Please send bug reports, feature requests, and other questions to
+
+    snakemake-mode@inbox.kyleam.com
+
+You can browse previous discussion and development via the
+public-inbox [^2] archives at
+
+    https://inbox.kyleam.com/snakemake-mode/
+
+If you'd like to contribute a patch, thank you!  Please send
+it to the same address.
+
+For more information on sending patches, visit
+<https://git-send-email.io/>.
+
+[^2]: https://public-inbox.org/README