diff --git a/README.md b/README.md index 6997247..4c8570b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# tikker +# Tikker -Application to monitor your key presses \ No newline at end of file +Tikker is Dutch for typer. + +This is an application for monitoring your key presses. + +It will store all your keypresses in a database called 'tikker.db' in current work directory. + +## Usage +Execute as root is important! +``` +sudo ./tikker +``` +It can be annoying to have the terminal open the whole day. I advise to use tmux or install it as systemd service. If you install it as systemd service, you're sure you'll never miss a key press! Make sure that you define the work directory where the database should be stored in systemd service. + +## Compilation +Compilation requires sqlite3 development header files. +``` +sudo apt install libsqlite3-dev +``` +Building: +``` +make build +``` +Building and running: +``` +make +```