Browse Source

markdown format of the readme content

Daniel-Constantin Mierla 9 years ago
parent
commit
eab608c0d7
1 changed files with 16 additions and 11 deletions
  1. 16 11
      README.md

+ 16 - 11
README.md

@@ -1,22 +1,27 @@
-Overview
+## Overview ##
 --------
 
-Vim scripts to auto-detect Kamailio configuration files and
-enable syntax highlighting for them.
+Vim scripts to auto-detect Kamailio configuration files (aka kamailio.cfg)
+and enable syntax highlighting for them. More about Kamailio can be found at:
 
-Install
--------
+  * https://www.kamailio.org
+
+### Install ###
 
 Run 'make install' in this folder, or:
-	- copy ftdetect/kamailio.vim to ~/.vim/ftdetect/kamailio.vim
-	- copy syntax/kamailio.vim to ~/.vim/syntax/kamailio.vim
 
-Usage
------
+  * copy ftdetect/kamailio.vim to ~/.vim/ftdetect/kamailio.vim
+  * copy syntax/kamailio.vim to ~/.vim/syntax/kamailio.vim
+
+### Usage ###
 
-- autodetection is based on .cfg extension and match of #!SER,
-#!KAMAILIO (and other variants), modparam or route keywords in
+Autodetection is based on __.cfg__ extension and match of __#!KAMAILIO__,
+__#!SER__, (and other variants), __modparam__ or __route__ keywords in
 first 400 lines of file. You can enable syntax highlighting for files
 not auto-detected with vim command:
 
+```
   setf kamailio
+```
+
+Enjoy!