From 4a1e66b674ebc3685a20b8879565c6c90f1211c8 Mon Sep 17 00:00:00 2001 From: Casey Scarborough Date: Mon, 16 Sep 2013 21:26:09 -0400 Subject: [PATCH] Update README.md. --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 87ffbb8..d5eec3f 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,31 @@ Start by cloning the repository and running the proper make commands, shown belo ```bash $ git clone https://github.com/caseyscarborough/keylog && cd keylog -$ make -$ make install +$ make && make install ``` -The application by default logs to `/var/log/keystroke.log`, which may require root access depending on your system's permissions. You can change this in [`keylogger.h`](https://github.com/caseyscarborough/keylog/blob/master/keylogger.h#L14) if necessary. +The application by default logs to `/var/log/keystroke.log`, which may require root access depending on your system's permissions. You can change this in [`keylogger.h`](https://github.com/caseyscarborough/keylog/blob/master/keylogger.h#L12) if necessary. ```bash $ sudo keylogger Logging to: /var/log/keystroke.log ``` +### Optional Parameters + +You can pass in two optional parameters to the program. The `clear` option will clear the logs at the default location. Any other argument passed in will be used as the path to the log file for that process. See below: + +```bash +# Clear the logfile. +$ sudo keylogger clear +Logfile cleared. +Logging to: /var/log/keystroke.log + +# Specify a logfile location. +$ sudo keylogger ~/logfile.txt +Logging to: /Users/Casey/logfile.txt +``` + ## Contributing Feel free to fork the project and submit a pull request with your changes! \ No newline at end of file