Update README.md

aarongraham · Aug 27, 2014 · cafeaf6 · cafeaf6
1 parent dd26346
commit cafeaf6
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# Sublime Syntax highlighting Splunk
+
+A Sublime syntax definition for the Splunk Search Processing language to enable syntax highlighting
+
+## Install Manually
+
+* Place the .tmLanguage file inside the Sublime packages folder (`Preferences | Browse Packages...`)
+* Restart Sublime
+
+## Development
+* Install [AAAPackageDev](https://github.com/SublimeText/AAAPackageDev)
+* Work on the JSON files and use [AAAPackageDev](https://github.com/SublimeText/AAAPackageDev) to complie them to the XML format required by Sublime
+* A good starting guide can be found [here](http://docs.sublimetext.info/en/latest/extensibility/syntaxdefs.html)
+
+## License
+This package is licensed under the MIT License.