From 0e3ce083a50498f8d1da76b5f55f500a7ef090ce Mon Sep 17 00:00:00 2001
From: structix <janek@schoff.it>
Date: Tue, 1 Nov 2022 21:46:05 +0100
Subject: [PATCH] Update README

---
 README.md   | 9 ++++++++-
 src/main.rs | 2 +-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 425b927..134ac61 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,10 @@
 # obs-cli
 
-A command line tool for obs
\ No newline at end of file
+obs-cli is a simple cli tool for planned OBS recordings.
+
+## Usage
+* `-s`, `--start-minutes` `<START_MINUTES>`: Define the minutes where the recording should start [default: 0]
+* `-d`, `--duration-minutes` `<DURATION_MINUTES>`: Define the duration of the recording in minutes [default: 1]
+* `-p`, `--poweroff`: Flag to shutdown the machine after recording
+* `-h`, `--help`: Print help information
+* `-V`, `--version`: Print version information
diff --git a/src/main.rs b/src/main.rs
index 2db7a08..7d2c62a 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -78,7 +78,7 @@ async fn shutdown() -> Result<(), anyhow::Error> {
 }
 
 
-// obs-cli is a simple cli tool for planned obs recordings
+/// obs-cli is a simple cli tool for planned OBS recordings
 #[derive(Parser, Debug)]
 #[command(author, version, about, long_about = None)]
 struct Args {