From 9052895fcce581685eccbf9761e1ee64d791248c Mon Sep 17 00:00:00 2001
From: Mallikarjunarao Kosuri <venkatamallikarjunarao.kosuri@adtran.com>
Date: Thu, 26 Jul 2018 13:22:47 +0530
Subject: [PATCH] imporve on instructions

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 36 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index a189ca6..a057c00 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,51 @@
-# lang-robot
+# Robotframework syntax highlighter for :pencil: **Notepad++**
 
-Robotframework syntax highlighter for **Notepad++**
+## Importing a user defind language in Notepad++
 
-## Notepad++
+1. Download the repository from GitHub https://github.com/vkosuri/npp-robot/archive/master.zip
+2. Extract zipped file into local directory.
+3. Open :pencil: Notepad++ on your machine.
+4. From Menu Bar selecte Langugage -> User-Defined
 
-## Importing a user defind language
+    ![user-defined-pop-up](http://docs.notepad-plus-plus.org/images/1/1a/Udl_tuto02.gif "User-Defined")
 
-Langugage -> User-Defined
+5. Select Import
 
-![alt text](http://docs.notepad-plus-plus.org/images/1/1a/Udl_tuto02.gif "User-Defined")
+    ![import-undock](http://docs.notepad-plus-plus.org/images/8/80/Ulds_undock.png "Import")
 
-Select Import
+6. Select UDL xml **lang-robot.xml** file
 
-![alt text](http://docs.notepad-plus-plus.org/images/8/80/Ulds_undock.png "Import")
+After import you will observe the syntax highlighter start working :boom: :sparkles: :tada: 
 
-Select UDL xml **lang-robot.xml** file
+> If you find any difficuty while importing ``lang-robot.xml`` This thread might help to resolve your issue. https://github.com/vkosuri/npp-robot/issues/3#issuecomment-305343247 [![](https://i.imgur.com/9wQkGeP.png)](../labels/comments)
 
-Below screen shot summaries the how it looks and color represents
+> The sytanx highligher works **<file_name>.robot** extension files only
 
-```
-Blue - Keywords
-Orange - Variables
-Green - Comments
-```
+A sample screenshot that summaries the how it looks.
 
 ![syntax-highlighter](https://cloud.githubusercontent.com/assets/13664257/12018694/650545a2-ad8c-11e5-8bf2-52719ab60f0a.png)
 
+## Colors used
+<p><span style="color:blue"><em>Blue</em> - Keywords</span>.</p>
+<p><span style="color:orange"><em>Orange</em> - Variables</span>.</p>
+<p><span style="color:green"><em>Green</em> - Comments</span>.
 
-**After import the syntax will work .robot files only**
+## History
+
+See release notes for changes https://github.com/vkosuri/npp-robot/releases
+
+## Development pattern for contributors
+
+* Create a fork of the main repository on GitHub.
+* Make your changes in a branch named something different from master, e.g. create a new branch my-pull-request.
+* Create a pull request.
+
+## Known issues
+* [syntax highligher broken on certain charecters](https://github.com/vkosuri/npp-robot/issues/5) [![](https://i.imgur.com/hgS76Kz.png)](../labels/help-wanted) [![](https://i.imgur.com/Bie8PhC.png)](../labels/enhancement)
+
+## License
+
+This sytanx highlighter is licensed under the [MIT License](https://github.com/vkosuri/npp-robot/blob/master/LICENSE.md).
+
+Enjoy ¯\\\_(ツ)\_/¯
 
-Enjoy...