focuz 0.0.1

<div align="center">

# 🎯 Focuz

**Lightweight Beautiful Terminal Pomodoro Timer**

[![Crates.io](https://img.shields.io/crates/v/focuz?style=flat-square)](https://crates.io/crates/focuz)
[![Crates.io](https://img.shields.io/crates/d/focuz?style=flat-square)](https://crates.io/crates/focuz)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT)
[![Contributors](https://img.shields.io/github/contributors/shiyasmohd/focuz?style=flat-square)](https://github.com/shiyasmohd/focuz/graphs/contributors)

<br/>

</div>


![Screenshot](assets/demo.png)

## 🛠️ Prerequisites

- **Rust** - [Install Rust](https://doc.rust-lang.org/book/ch01-01-installation.html)

## 📦 Installation

```bash
cargo install focuz
```

## 🚀 Usage

```bash
# Run a timer for specific duration
focuz <duration>
```

### Examples

```bash
focuz 10s    # 10 seconds timer
focuz 5m     # 5 minutes timer  
focuz 2h     # 2 hours timer
focuz 90     # 90 seconds (no suffix defaults to seconds)
```

### Time Format

- `s` or no suffix - seconds (e.g., `30s` or `30`)
- `m` - minutes (e.g., `5m`)
- `h` - hours (e.g., `2h`)

## ⌨️ Keyboard Shortcuts

| Key | Action |
|-----|--------|
| `q` or `Esc` | Quit the timer |
| `Ctrl+C` | Force quit |


## 🔊 Sound Notifications

- **Start Sound** - Plays when timer begins
- **End Sound** - Plays when timer completes

## 🏗️ Building from Source

```bash
# Clone the repository
git clone https://github.com/shiyasmohd/focuz.git
cd focuz

# Build the project
cargo build --release

# Run directly
cargo run -- 5m

```

## 🧪 Running Tests

```bash
# Run all tests
cargo test

# Run with output
cargo test -- --nocapture
```

## 📁 Project Structure

```
focuz/
├── src/
│   ├── main.rs           # Entry point
│   ├── cli/              # Command-line interface
│   │   ├── mod.rs
│   │   └── cli.rs        # CLI parsing and duration handling
│   └── timer/            # Timer functionality
│       ├── mod.rs
│       ├── timer.rs      # Core timer logic
│       ├── display.rs    # ASCII art display
│       └── sound.rs      # Audio notifications
├── sounds/               # Audio files
│   ├── start.wav
│   └── end.mp3
├── Cargo.toml
└── README.md
```

## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE-MIT) file for details.

<div align="center">
Made with ❤️ in Rust 🦀
</div>