Rename README

1 files changed, 19 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ec84d70
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+
+[![Build Status](https://travis-ci.org/kyleam/snakemake-mode.svg?branch=master)](https://travis-ci.org/kyleam/snakemake-mode)
+
+This repo contains two Emacs libraries for [Snakemake].
+
+* [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].
+
+[Snakemake]: https://snakemake.readthedocs.io/en/stable/
+[snakemake-mode.el]: https://git.kyleam.com/snakemake-mode/tree/snakemake-mode.el#n24
+[snakemake.el]: https://git.kyleam.com/snakemake-mode/tree/snakemake.el#n21
+[snakemake-mode package]: https://melpa.org/#/snakemake-mode