diff --git a/README.md b/README.md index e69de29..4c569cd 100644 --- 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.