# citron

citron provides system data via on-demand notifications, it is essentially an
alternative to status bars that is meant to be used through keybindings defined
in your window manager's configuration.

It is designed to stay out of your way. The moment you want to know something,
like today's date for example, you tap a keybinding — and instantly, a
notification pops up with the data you requested, and then simply goes away
after a few seconds.

## Contributing and bug reports

- We accept contributions via email at
  [~grtcdr/citron@lists.sr.ht](mailto:~grtcdr/citron@lists.sr.ht).
- Issues should be filed in [our ticket
  tracker](https://todo.sr.ht/~grtcdr/citron).

## Installation

Check out the [installation wiki page](https://man.sr.ht/~grtcdr/citron/install.md).

## Getting started

Check out the [main wiki page](https://man.sr.ht/~grtcdr/citron/).

## Configuration

Check out the [configuration wiki page](https://man.sr.ht/~grtcdr/citron/configure.md).

## Acknowledgements

- Thank you to
  [pin@NetBSD.org](https://pkgsrc.se/bbmaint.php?maint=pin@NetBSD.org) for
  packaging and maintaining citron on NetBSD.

## Screenshot

![A preview of citron in action.](assets/preview.png)