branch: elpa/kotlin-mode
commit f54da34b3f6b2bfae622fffcd0ade20e98e63458
Merge: e1540a5ddf 37b93116c9
Author: Russel Winder <[email protected]>
Commit: GitHub <[email protected]>
Merge pull request #11 from russel/master
Make a start at a README
---
README.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/README.md b/README.md
index aa82bd50b1..783ec534f3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,18 @@
+# Emacs Kotlin Mode
+
[](https://melpa.org/#/kotlin-mode)
+
+In a sense the title says it all, this is an
[Emacs](https://www.gnu.org/software/emacs/) major mode for
+editing [Kotlin](http://kotlinlang.org/) source code – and in the future
[Gradle](http://gradle.org/) build
+files.
+
+If you are using Emacs 24 or later, use the package management system to
install this mode from
+[MELPA](http://melpa.org/) (*).
+
+If you are using an earlier version of Emacs, you are probably best advised to
upgrade Emacs to a version
+with package management so you can use package management to install the mode
from MELPA.
+
+
+
+(*) As at 2016-06-20 this mode is only in MELPA and not in MELPA stable, a
release will be made when a
+version is ready to be declared.