# Introduction <img src="./images/logo.svg" alt="Tomat logo" class="right" style="width: 192px;" />

Welcome to the documentation for **Tomat {{ tomat-version }}**, a customizable
and lightweight Pomodoro timer designed for seamless integration with waybar and
other status bars.

To get started, have a look at [Getting Started](guide/getting_started.md) for a
quick guide to install and setup Tomat.

## Contents

This documentation includes the following sections:

- [Getting Started](guide/getting_started.md): Quick start guide to install and
  use Tomat.
- [Configuration](guide/configuration.md): Overview of configuration options.
- [Integration](guide/integration/index.md): Guides to integrate Tomat with
  various status bars and notification systems.
- [Troubleshooting](guide/troubleshooting/index.md): Solutions to common issues.
- [Configuration Reference](configuration/index.md): In-depth reference for all
  configuration options.
- [CLI Reference](cli-reference.md): Comprehensive reference for all CLI
  commands and options.

## Additional Resources

- **[Main repository](https://github.com/jolars/tomat)**
- **[Crates.io page](https://crates.io/crates/tomat)**
- **[A blog post about Tomat](https://jolars.co/blog/2026-01-12-tomat/)**

## Support

- **GitHub Issues**:
  [Report bugs or request features](https://github.com/jolars/tomat/issues)
- **GitHub Discussions**:
  [Ask questions or share ideas](https://github.com/jolars/tomat/discussions)
- **Pull Requests**:
  [Contribute code improvements](https://github.com/jolars/tomat/pulls)

## Contributing

Contributions are welcome! Please see the [Contributing Guide](contributing.md)
for details on how to get involved.
