From 2922ff93b8c1d369fb5ada5a40665df41ce468db Mon Sep 17 00:00:00 2001
From: Jorge Dominguez <jorge@innova-code.com>
Date: Sat, 22 Sep 2018 16:23:14 -0400
Subject: [PATCH] updating readme with the installation instructions

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 336f0e5..805cc33 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-substitutions_plugin
+# Marvinbot Substitutions Plugin
+
+A plugin to help your friend with the typo he made or change the complete word of a sentence.
+
+# Requirements
+
+-   A working [Marvinbot](https://github.com/BotDevGroup/marvin) install
+
+# Getting Started
+
+Download the source:
+
+```
+$ git clone git@github.com:BotDevGroup/substitutions_plugin.git
+```
+
+Install the plugin into your virtualenv:
+
+```
+(venv)$ python setup.py develop
+```
+
+Open your marvinbot `settings.json` and `substitutions_plugin` to your `plugins` list.
+
+#How to use
+Pending...