diff --git a/README.md b/README.md index 5ca2a43..4722183 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # nicethings -A poorly written python script that is to be used on shared unix servers to cheer people up +A Python program to be used on shared unix servers to cheer people up -### Note: +## Note: I've modified the file paths in this script so it will work on [tilde.town](https://tilde.town). You can adjust it accordingly -### How it works -It stores user{'s/s'} input into a text file if an argument is given. If no arguments are given, a random nice message from the text file will be displayed. +## How it works +It stores the user's input into a text file if an argument is given in quotes. If no arguments are given, a random nice message from the text file will be displayed. -### Usage -##### Adding a message to the file: +## Usage +### Adding a message to the file: `$ nicethings "insert your message here"` -##### Randomly generate a message: +### Randomly generate a message: `$ nicethings`