Skip to content

Commit

Permalink
add link to class in README
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh committed Dec 1, 2023
1 parent 0fce7b0 commit c686d9b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c686d9b

Please sign in to comment.