feat: add README.md

Signed-off-by: Moritz Böhme <moritz@noreply.localhost>
This commit is contained in:
Moritz Böhme 2023-06-21 17:55:33 +02:00 committed by Moritz Böhme
parent 194e5112e5
commit a5cac154f4
Signed by: moritz
GPG key ID: 970C6E89EB0547A9

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# time(rs)
A simple Rust program that implements a timer daemon and CLI. It allows users to interact with timers by adding, removing, and listing them. The daemon listens for incoming connections and handles commands sent by the CLI. The CLI provides a convenient interface for users to interact with the daemon.
## Example Usage
Here is an example of how the timer daemon and CLI can be used together:
1. Start the timer daemon by running the command `timers daemon`.
2. In a separate terminal, use the CLI to interact with the timer daemon:
- Add a timer: `timers add <name> <duration_seconds>`
- List timers: `timers list`
- Remove a timer: `timers remove <name>`
The timer daemon will receive the commands from the CLI and perform the requested actions. The CLI will display the responses from the timer daemon.