add readme

README.md

@@ -0,0 +1,27 @@
+# Name
+ct - custom timer
+
+# Prerequisites
+
+- zenity
+- pipewire
+
+# Summary
+
+ct is a timer application that play sound and display dialogue (with unconfigurable text, for now) on completion.
+User can configure the timeout by providing 1st argument as a non-negative integer.
+
+example:
+`ct 5` - this will schedule timer to run for 5 seconds and then fire bundled alarm sound + show dialog
+
+User can configure measurement unit (minutes or seconds) by providing 2nd argument (single character, either 'm' or 's'), though it is _optional_
+Default behavior: choose seconds.
+
+example:
+`ct 10 m` - this will schedule timer to run for 10 minutes and then fire bundled alarm sound + show dialog
+
+User can configure alert sound by providing 3rd argument as a system path, though it is _optional_. If user wants to provide alert sound path, they should provide 2nd argument.
+Default behavior: bundled alert sound will play.
+
+example:
+`ct 15 s ~/Music/alert.opus` - this will schedule timer to run for 15 seconds and then play ~/Music/alert.opus + show dialog