README & example update

Use `Kaleiodscope.use` instead of `USE_PLUGINS` in both README and the example.
Also create a separate "Plugin properties" section in the former.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 7 years ago
parent e64f489845
commit 40c843958a

@ -41,7 +41,7 @@ plugin:
OSM(LeftControl), OSL(_FN) OSM(LeftControl), OSL(_FN)
void setup() { void setup() {
USE_PLUGINS(&OneShot); Kaleidoscope.use(&OneShot);
Kaleidoscope.setup(); Kaleidoscope.setup();
} }
@ -68,7 +68,7 @@ There are two macros the plugin provides:
## Plugin methods ## Plugin methods
The plugin provides one object, `OneShot`, which implements both one-shot The plugin provides one object, `OneShot`, which implements both one-shot
modifiers and one-shot layer keys. It has the following methods and properties: modifiers and one-shot layer keys. It has the following methods:
### `.isActive()` ### `.isActive()`
@ -94,6 +94,11 @@ modifiers and one-shot layer keys. It has the following methods and properties:
> sticky one-shot effects. If omitted, it defaults to `false`, and not canceling > sticky one-shot effects. If omitted, it defaults to `false`, and not canceling
> stickies. > stickies.
## Plugin properties
Along with the methods listed above, the `OneShot` object has the following
properties too:
### `.time_out` ### `.time_out`
> Set this property to the number of milliseconds to wait before timing out and > Set this property to the number of milliseconds to wait before timing out and

@ -58,7 +58,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = {
}; };
void setup() { void setup() {
USE_PLUGINS(&OneShot); Kaleidoscope.use(&OneShot);
Kaleidoscope.setup(); Kaleidoscope.setup();
} }

Loading…
Cancel
Save