From f3e615ba80033965229276d8314a931adadd8422 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 15:49:09 +0200 Subject: [PATCH] README.md: Properties are not methods Signed-off-by: Gergely Nagy --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e6de649d..74ce3704 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ hence the macro. ## Plugin methods The plugin provides the `GhostInTheFirmware` object, which has the following -methods: +methods and properties: ### `.activate()` @@ -66,17 +66,15 @@ methods: ### `.ghost_keys` -> Set the sequence of keys to press, by assigning a sequence to this variable. -> Each element is a quartett of `row`, `column`, a `pressTime`, and a `delay`. -> Each of these will be pressed in different cycles, unlike macros which play -> back within a single cycle. +> Set this property to the sequence of keys to press, by assigning a sequence to +> this variable. Each element is a quartett of `row`, `column`, a `pressTime`, +> and a `delay`. Each of these will be pressed in different cycles, unlike +> macros which play back within a single cycle. > > The key at `row`, `column` will be held for `pressTime` milliseconds, and > after an additional `delay` milliseconds, the plugin will move on to the next > entry in the sequence. > -> Not strictly a method, it is a variable one can assign a new value to. -> > The sequence *MUST* reside in `PROGMEM`. ## Further reading