From a5cac154f4a5d00d63a4637f9ce3d9949402405a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20B=C3=B6hme?= Date: Wed, 21 Jun 2023 17:55:33 +0200 Subject: [PATCH] feat: add README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Moritz Böhme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4056a24 --- /dev/null +++ b/README.md @@ -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 ` + - List timers: `timers list` + - Remove a timer: `timers remove ` + +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.