From 415e42a57bf1bb9586870fbec04c5f0ad88f64eb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 6 Jun 2017 14:52:52 +0200 Subject: [PATCH] Document the Focus hooks Fixes #3. Signed-off-by: Gergely Nagy --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index c8e50aec..e9810340 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,32 @@ properties. All times are in milliseconds. > > Defaults to 0 (off). +## Focus commands + +The plugin provides a single `Focus` hook, `FOCUS_HOOK_TYPINGBREAKS`, which in +turn make a few commands available. All of these return the respective setting's +value when called without arguments, or set them if called with some. + +### `typingbreaks.idleTimeLimit [limit]` + +> Get or set the `.settings.idle_time_limit` property. + +### `typingbreaks.lockTimeOut [time_out]` + +> Get or set the `.settings.lock_time_out` property. + +### `typingbreaks.lockLength [length]` + +> Get or set the `.settings.lock_length` property. + +### `typingbreaks.leftMaxKeys [max]` + +> Get or set the `.settings.left_hand_max_keys` property. + +### `typingbreaks.rightMaxKeys [max]` + +> Get or set the `.settings.right_hand_max_keys` property. + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting