extension/README.md
# Purr Extension
This is the part of Purr responsible for providing a communication channel between the client and the JS frontend.
## Installation
The extension is available from the [Chrome Web Store](https://chrome.google.com/webstore/detail/purr/kbobleenjfbacnajgodnjbbnekmocooh) and from the [Mozilla Addons](https://addons.mozilla.org/en-US/firefox/addon/purr/).
## Usage
The extension is not designed for standalone usage, rather to be called from the browser using the frontend library.
## Development
After checking out the repo, run `npm install` or `yarn install` in the `extension` subdirectory to install dependencies. You can also run `yarn test` to run all the tests. There are other development-related commands available in the form of gulp tasks, type `gulp help` to list all of them.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/skateman/purr.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).