From 40c843958a01c04b3e333737cee0b77ae6fe0f72 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 10 Aug 2017 08:33:04 +0200 Subject: [PATCH] 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 --- README.md | 9 +++++++-- examples/OneShot/OneShot.ino | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a4e0aa07..a01674e5 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ plugin: OSM(LeftControl), OSL(_FN) void setup() { - USE_PLUGINS(&OneShot); + Kaleidoscope.use(&OneShot); Kaleidoscope.setup(); } @@ -68,7 +68,7 @@ There are two macros the plugin provides: ## Plugin methods 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()` @@ -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 > stickies. +## Plugin properties + +Along with the methods listed above, the `OneShot` object has the following +properties too: + ### `.time_out` > Set this property to the number of milliseconds to wait before timing out and diff --git a/examples/OneShot/OneShot.ino b/examples/OneShot/OneShot.ino index 22a13427..1711f680 100644 --- a/examples/OneShot/OneShot.ino +++ b/examples/OneShot/OneShot.ino @@ -58,7 +58,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup() { - USE_PLUGINS(&OneShot); + Kaleidoscope.use(&OneShot); Kaleidoscope.setup(); }