README.md: A few words about the plugin

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/365/head
Gergely Nagy 8 years ago
parent 6b7bafc08f
commit 3276b97a2e

@ -1,5 +1,35 @@
# Kaleidoscope-LEDEffect-Breathe
This is a plugin for [Kaleidoscope][fw], adding a breathe LED effect.
![status][st:stable] [![Build Status][travis:image]][travis:status]
[fw]: https://github.com/keyboardio/Kaleidoscope
[travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-LEDEffect-Breathe.svg?branch=master
[travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-LEDEffect-Breathe
[st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52
[st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52
[st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52
Provides a breathing effect for the keyboard. Breathe in, breathe out.
## Using the extension
To use the plugin, include the header, and tell the firmware to use it:
```c++
#include <Kaleidoscope-LEDEffect-Breathe.h>
void setup() {
Kaleidoscope.use(&LEDBreatheEffect);
Kaleidoscope.setup();
}
```
## Plugin methods
The plugin provides the `LEDBreatheEffect` object, which has no public methods or
properties, outside of those provided by all LED modes.
## Dependencies
* [Kaleidoscope-LEDControl](https://github.com/keyboardio/Kaleidoscope-LEDControl)

Loading…
Cancel
Save