diff --git a/README.md b/README.md index 46de8e2..329f872 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,55 @@ ## What is ssh-watcher: A simple background shell script that watches for ssh activities and alerts you via xmessage.
-Activities includes: ssh login, logout and failed login attemps.
+Activities includes: ssh login, logout, and failed login attemps.

## How it works: Ssh watcher simply watches your `/var/log/auth.log`.
-It's desined and tested on raspberry pi, but may be able to run on other os's.
+It's desined and tested on raspberry pi, but may be able to run on other OSs.
-You can also make this automatically run on start up, +You can also make this automatically run on start up [for raspberry pi](#to-make-it-run-on-boot-or-startup-for-raspberry-pi).

## How to install and use the gui script: -Just put the `ssh-watcher-gui-vX.X.sh` in whatever directory you like, probability best in you home directory,
-then run it! `./ssh-watcher-gui-vX.X.sh`
+Just put the `ssh-watcher-gui-vX.X.sh` in whichever directory you like, probably best in your home directory,
+and then run it! `./ssh-watcher-gui-vX.X.sh`
If you don't want your terminal to be busy running it, then do `./ssh-watcher-gui-vX.X.sh &`.

## How to install and use the cli script: -Put the `ssh-watcher-cli-vX.X.sh` in your home directory, or whatever you like.
+Put the `ssh-watcher-cli-vX.X.sh` in your home directory, or wherever you like.
To run it, you can do `./ssh-watcher-cli-vX.X.sh`, and you can do `./ssh-watcher-cli-vX.X.sh -h` for more options.

## Cli vs Gui: -There are two difrent scripts, the `ssh-watcher-gui-vX.X.sh` if for raspberry pi's with a GUI and display,
-and the `ssh-watcher-cli-vX.X.sh` is for raspberry pi's without a GUI or display.
+There are two difrent scripts, the `ssh-watcher-gui-vX.X.sh` if for a raspberry pi with a GUI and display,
+and the `ssh-watcher-cli-vX.X.sh` is for a raspberry pi without a GUI or display.

-**Note:** the gui script alerts via xmessage, and the cli script alerts thrught the terminal thats running it.
+**Note:** the gui script alerts via xmessage, and the cli script alerts thrught the terminal that's running it.

## To make it run on boot or startup for raspberry pi: -open a terminal and type:
+Open a terminal and type:
`vim ~/.bashrc`
-then at the top, or the bottom, write:
+Then at the top, or the bottom, write:
`./ssh-watcher.sh &> /dev/null &`
-save and exit then you done!
+save and exit, then you done!
Make sure you script is in your home directory, or include a path to it.
-this should work for the latest version of Raspbian.
+This should work for the latest version of Raspbian.