update readme

Author: msLinuxNinja

README.md

@@ -1,2 +1,36 @@
 # chronox
-A simple Rust utility to convert log files to UTC 🦀
+A simple Rust utility to convert log files from local time to UTC 🦀.
+
+
+It takes dates in `Month Day HH:MM:SS` format and converts it to `YYYY-MM-DD HH:MM:SS Z` format.
+
+For example using a -06:00 offset:
+
+```
+Aug 27 00:00:00 host systemd[1]: Reloaded httpd.service - The Apache HTTP Server.
+```
+
+Gets converted to:
+```
+2023-08-27 06:00:00 UTC host systemd[1]: Reloaded httpd.service - The Apache HTTP Server.
+```
+
+# Usage
+`chronox` can be used from the command line with the following syntax:
+
+```bash
+chronox [logfile] [timezone offset]
+```
+
+The timezone offset needs to be in `-+00:00` format.
+
+A file with the suffix `-chronox` will be saved in the same directory as the original file.
+
+# Downloading
+
+Grab one of the binaries from the [releases page]().
+
+# Gotchas
+
+* The utility assumes the year is current year.
+* Only files that use `Month Day HH:MM:SS` format would work (Like `messages` or `syslog`).

src/main.rs

@@ -24,8 +24,8 @@ fn get_time_utc(date_str: String) -> DateTime<Utc> {
 }
 
 fn print_usage() {
-    println!("Usage: <filename> <timezone offset in +-06:00 format>");
-    println!("Converts log time entries to UTC time");
+    println!("Usage: ./chronox <filename> <timezone offset in +-06:00 format>");
+    println!("Converts log time entries to UTC");
     println!("Example: ./chronox messages -06:00");
 }