From a4fe24a48b774ddff471af1b72a365355cdcf805 Mon Sep 17 00:00:00 2001
From: Maciej Szlosarczyk <maciej.szlosarczyk@inbank.ee>
Date: Thu, 27 Apr 2017 08:00:09 +0300
Subject: [PATCH] Add readme file

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8bdf53e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# My emacs config
+
+Contains config I use for the following languages/modes:
+
+* Elixir
+* Ruby
+* Rust
+* HTML and compatibile (ERB)
+* Markdown
+
+## Installation
+
+```bash
+git clone git@github.com:maciej-szlosarczyk/emacs.git ~/.emacs.d
+ln -s ~/.emacs.d/emacs ~/.emacs
+```
+
+
+## Selected packages
+
+The following packages are included or required:
+
+* Evil
+* Magit
+* Helm
+* Projectile
+* Company
+* Yasnippet
+* Column Enforce Mode
+* Ag
+
+## Compatibility notes
+
+Tested on MacOS, requires additional packages such as ag (`the_silver_searcher`).