From 925d09422dcc0a6e4af45de97ff2d9297b69b30e Mon Sep 17 00:00:00 2001
From: jjanzen <jjanzen@jjanzen.ca>
Date: Mon, 10 Mar 2025 15:44:36 -0500
Subject: [PATCH] update readme

---
 README.md        | 39 ++++++++++++++++++++++++++++++++++++++-
 pomodoro-mode.el |  5 ++---
 2 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4a1e7a7..0594e0a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,44 @@
 # 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
+Add a simple [pomodoro](https://en.wikipedia.org/wiki/Pomodoro_Technique) timer to your Emacs mode-line.
+
+Defaults to `🍅 (MM:SS)` when working and `🥫 (MM:SS)` when taking a break.
+
+## Installation
+
+The package can be manually installed by saving `pomodoro-mode.el` to `~/emacs.d/` or wherever your emacs configuration is stored and load the package with
+```cl
+(add-to-list 'load-path "~/.emacs.d/") ; Adjust this path if necessary
+
+(require 'pomodoro-mode)
+```
+
+In Emacs 30.1 and above, `use-package` works well with version control, allowing the following
 ```cl
 (use-package pomodoro-mode
   :ensure (pomodoro-mode :host github :repo "jjanzenn/pomodoro-mode"))
 ```
+
+## Usage
+
+- Start a pomodoro session with `M-x pomodoro-mode`.
+- Stop a pomodoro session with `M-x pomodoro-mode`.
+- Move to the next work or break period with `M-x pomodoro-toggle-state`.
+
+## Customization
+
+This is a simple package that doesn't do much. That being said, you can customize some aspects of the mode:
+- `pomodoro-work-time`: the number of seconds in a work session; defaults to 1500 (25 minutes)
+- `pomodoro-break-time`: the number of seconds in a break session; defaults to 300 (5 minutes)
+- `pomodoro-work-symbol`: the string to display while in a work session; defaults to 🍅
+- `pomodoro-break-symbol`: the string to display while in a break session; defaults to 🥫
+
+These can be customized with `M-x customize-group` in the `pomodoro` group. Alternatively, you can modify your `init.el` file to set the variables with `setq`.
+
+## Contributing
+
+Feel free to publish issues or create pull requests if you have suggestions on how to improve this package.
+
+## License
+
+Distributed under the GNU General Public License v3.0. See `LICENSE` for more information.
diff --git a/pomodoro-mode.el b/pomodoro-mode.el
index 7fed3f7..87adcd5 100644
--- a/pomodoro-mode.el
+++ b/pomodoro-mode.el
@@ -17,8 +17,7 @@
 
 
 ;; Author: j. janzen <jjanzen@jjanzen.ca>
-;; Version: 0.2
-;; Package-Requires: ()
+;; Version: 0.1
 ;; Keywords: productivity, convenience
 
 ;;; Commentary:
@@ -29,7 +28,7 @@
 ;;;###autoload
 (defgroup pomodoro nil
   "Pomodoro timer"
-  :group 'convenience)
+  :group 'applications)
 
 ;;;###autoload
 (defcustom pomodoro-start-time 0