ABOUT
=====

`coala-sublime` offers a plugin for sublime-text to use the
code analysis software inside sublime-text editor. Currently
sublime-text-3 is the only supported version of sublime-text.

INSTALLATION
============

### Dependencies
 - [coala](https://github.com/coala-analyzer/coala) needs to be
   installed and the coala binaries should be added to the PATH

### Package control
For easy installation, use Package Control to install the plugin.
We're available in PackageControl under the name
[coala](https://packagecontrol.io/packages/coala).

### Manual installation
To install `coala-sublime` manually, clone this repository to
sublime-text's Package directory. The Package directory can
be opened using the "Preferences - Browse Packages" option
in sublime-text's command pallete or through the
"Preferences" > "Browse Packages".

AUTHORS
=======

 - Abdeali J Kothari - <abdealikothari@gmail.com>
 - Lasse Schuirmann - <lasse.schuirmann@gmail.com>

If you have any questions regarding the plugin, don't hesitate
to create an issue or send us an email.

LICENSE
=======

[![AGPL](https://img.shields.io/github/license/coala-analyzer/coala.svg)](https://www.gnu.org/licenses/agpl-3.0.html)

This code falls under the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.