add README.md and docs in the script

README.md

@@ -0,0 +1,33 @@
+# mycaffeine
+
+a little linux tools that moves your pointer regularly to avoid the automatic screen lock on a computer you can't configure. it doesn't need root.
+
+# how to install
+
+you may want to copy the file /mycaffeine in the $PATH or somewhere you can run it quickly. you don't need to, it's just a standalone script.
+
+# how to use
+
+these commands assume you copied ./mycaffeine
+
+## how to start it
+```sh
+$ mycaffeine start
+```
+
+## how to stop it
+```sh
+$ mycaffeine stop
+```
+
+## how to check if it's currently running
+there is no command to do that, but you can just start it or stop it again to be sure it's running.
+
+## how to specify the interval
+change the value of the variable $DELAY in the script.
+
+## how to check if it works
+change the delay to 1 seconds and see if your pointer moves lol
+
+## what if it doesn't work
+i have no idea

mycaffeine

@@ -1,23 +1,32 @@
 #!/bin/bash
 
-# Made by zy (https://github.com/frzysk)
+# script made by zy (https://gitea.zaclys.com/frzysk)
 #
-# This scripts makes your pointer automatically move at a specific interval
-#  to avoid automatic lock of the computer.
-# Doesn't need root.
 #
-# How to start it:
-#     $ mycaffeine start
-# How to stop it:
-#     $ mycaffeine stop
-# How to check if it's currently running:
-#     don't
-# How to specify the interval:
-#     Change the value of the variable $DELAY in the script.
-# How to check if it works:
-#     Change the delay to 1 seconds and see if your pointer moves
-# What if it doesn't work:
-#     That would be sad
+# a little linux tools that moves your pointer regularly to avoid the automatic screen lock on a computer you can't configure. it doesn't need root.
+#
+#
+# HOW TO INSTALL
+#
+# you may want to copy this script in the $PATH or somewhere you can run it quickly. you don't need to, it's just a standalone script.
+#
+#
+# HOW TO USE
+#
+# these commands assume you copied ./mycaffeine
+#
+# how to start it
+#   $ mycaffeine start
+# how to stop it
+#   $ mycaffeine stop
+# how to check if it's currently running
+#   there is no command to do that, but you can just start it or stop it again to be sure it's running.
+# how to specify the interval
+#   change the value of the variable $DELAY below (in seconds).
+# how to check if it works
+#   change the delay to 1 seconds and see if your pointer moves lol
+# what if it doesn't work
+#   i have no idea
 
 DELAY=300 # in seconds