🍓

A Tiny Hammerspoon Pomodoro Timer for the Menubar

Fork of Cherry Tomato

Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Strawberry is a small light weight pomodoro timer written in Lua for Hammerspoon.

(back to top)

Built With

• Lua
• Hammerspoon

(back to top)

Getting Started

Prerequisites

Install hammerspoon

• hammerspoon

  # Initialize Hammerspoon
  brew install --cask hammerspoon

Installation

0. Make a spoons directory for hammerspoon

   mkdir ~/.hammerspoon/Spoons

1. Download Strawberry and it's dependencies

   # Create directories and touch files as needed
   curl -L https://github.com/Hammerspoon/Spoons/raw/master/Spoons/CountDown.spoon.zip > /tmp/CountDown.spoon.zip
   curl -L https://github.com/SaahilParikh/Strawberry/raw/main/Spoon/Strawberry.spoon.zip > /tmp/Strawberry.spoon.zip
   unzip /tmp/CountDown.spoon.zip -d ~/.hammerspoon/Spoons/
   unzip /tmp/Strawberry.spoon.zip -d ~/.hammerspoon/Spoons/

2. Add use strawberry spoon in your init.lua

   echo 'hs.spoons.use("Strawberry")' >> ~/.hammerspoon/init.lua

3. Clean up temporary files

   rm /tmp/CountDown.spoon.zip
   rm /tmp/Strawberry.spoon.zip

(back to top)

Usage

Currently the Strawberry Timer works as a full pomodoro timer. You can use it to start a 25 minute long work session or a 5/15 minute long break. Furthermore, you can let the timer run on a pomodoro loop!

For more examples, please refer to the Documentation

(back to top)

Roadmap

• 25 Minute Long Work Timer
• 5 / 15 Minute Long Break Timer
• Alerts When the Timer Ends
  • Pop up Box During Breaks
  • Option to Work/Break for Five More Minutes After Timer Ends
• Minimal Timer Bar at the Bottom of the Screen
• Pomodoro Loop Logic

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Saahil Parikh - SaahilParikh[at)berkeley(dot]edu

Project Link: https://github.com/SaahilParikh/Strawberry

(back to top)

Acknowledgments

• Cherry Timer

(back to top)