diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4632fd6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Nipun Sampath + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 752b9b5..58d9146 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ ## Ballerina syntax for sublime text 3 -Ballerina syntax highlighting and autocompletion package for Sublime Text 3. +Provides: +* Syntax Highlighting +* Autocompletion + +for ballerina source files on Sublime Text 3. + +### Installation + +#### - Manual Installation + +Clone the repository in `Sublime installation path\Packages\User` diectory + +#### - Via Package Control + +Not yet supported. + +### Autocompletion Hot Keys + +* Move forward through fields    =  tab +* Move backward through fields =  shift + tab + + +Shout-out to [ballerina-attic](https://github.com/ballerina-attic) for acting as a reference point for some of the regexes used here.