jjanzen/pomodoro-mode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add readme

Browse source
This commit is contained in:
jjanzen 2025-03-10 14:45:12 -05:00
parent 73093bdb22
commit 7c5dacf357
2 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md Normal file
View file

@ -0,0 +1,7 @@
# pomodoro-mode
Add a simple [pomodoro](https://en.wikipedia.org/wiki/Pomodoro_Technique) timer to your Emacs mode-line. To run the timer, type `M-x pomodoro-mode`. To stop the timer, type `M-x pomodoro-mode` once again. The package is not on Melpa, but it is relatively easy to install in Emacs 30.1 with
```cl
(use-package pomodoro-mode
:ensure (pomodoro-mode :host github :repo "jjanzenn/pomodoro-mode"))
```

4
pomodoro-mode.el
View file

@ -7,8 +7,8 @@
;;; Commentary:
;; This package provides a minor mode to add a simple pomodoro timer to your mode-line.
;; To activate it, run `M-x pomodoro-global-mode`.
;; To turn it off, run `M-x pomodoro-global-mode` once again.
;; To activate it, run `M-x pomodoro-mode`.
;; To turn it off, run `M-x pomodoro-mode` once again.
;;;###autoload
(defgroup pomodoro nil