From c686d9befeacb39cf6b2fad99755f9f8fd530b3b Mon Sep 17 00:00:00 2001 From: epwalsh Date: Fri, 1 Dec 2023 13:30:32 -0800 Subject: [PATCH] add link to class in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b35193..b30581d 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ This is a complete list of all of the options that can be passed to `require("po ## Defining custom notifiers -To define your own notifier you need to create a `pomo.Notifier` Lua class along with a factory `init` function to construct your notifier. Your `Notifier` class needs to have the following methods +To define your own notifier you need to create a [`pomo.Notifier`](https://github.com/epwalsh/pomo.nvim/blob/main/lua/pomo/notifier.lua) Lua class along with a factory `init` function to construct your notifier. Your `Notifier` class needs to have the following methods - `Notifier.start(self)` - Called when the timer starts. - `Notifier.tick(self, time_left)` - Called periodically (e.g. every second) while the timer is active. The `time_left` argument is the number of seconds left on the timer.