README.md: Properties are not methods

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 8 years ago
parent fbd21c0462
commit f3e615ba80

@ -58,7 +58,7 @@ hence the macro.
## Plugin methods ## Plugin methods
The plugin provides the `GhostInTheFirmware` object, which has the following The plugin provides the `GhostInTheFirmware` object, which has the following
methods: methods and properties:
### `.activate()` ### `.activate()`
@ -66,17 +66,15 @@ methods:
### `.ghost_keys` ### `.ghost_keys`
> Set the sequence of keys to press, by assigning a sequence to this variable. > Set this property to the sequence of keys to press, by assigning a sequence to
> Each element is a quartett of `row`, `column`, a `pressTime`, and a `delay`. > this variable. Each element is a quartett of `row`, `column`, a `pressTime`,
> Each of these will be pressed in different cycles, unlike macros which play > and a `delay`. Each of these will be pressed in different cycles, unlike
> back within a single cycle. > macros which play back within a single cycle.
> >
> The key at `row`, `column` will be held for `pressTime` milliseconds, and > 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 > after an additional `delay` milliseconds, the plugin will move on to the next
> entry in the sequence. > 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`. > The sequence *MUST* reside in `PROGMEM`.
## Further reading ## Further reading

Loading…
Cancel
Save