diff --git a/README.md b/README.md index fc7d92e..1865d5c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,28 @@ PlantUML mode for Emacs ======================= -**NOTE**: This is just a GitHub mirror of the nice job done by [Zhang +**NOTE**: This is currently almost only a GitHub mirror of the nice job done by [Zhang Weize](http://zhangweize.wordpress.com/2010/09/20/update-plantuml-mode/) -as I couldn't find anything like a source repository. +as I couldn't find anything like a source repository. Just minor changes were introduced. Provides a [PlantUml](http://plantuml.sourceforge.net/) major mode for Emacs. +Installation +============ + +Make sure you have [MELPA](http://melpa.org/) enabled in your ``emacs.d``. Then, you can just + + M-x package-install + puml-mode + +Enjoy! + +Usage +===== + +Currently, the only available documentation is that provided by [Zhang's post](http://zhangweize.wordpress.com/2010/09/20/update-plantuml-mode/). + License =======