diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 974ed58..ed4fb91 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # nicethings A Python program to be used on shared unix servers to cheer people up (A little program for [tilde.town](https://tilde.town)) -## How it works +# How it works Stores the user's input into a generated `list.txt` file if an argument is given in quotes. If no arguments are given, a random line from the `list.txt` file will be displayed. -## Usage -### Adding a message to the file: +# Usage +## Adding a message to the file: `$ nicethings "insert your message here"` -### Outputting a random line from list.txt: +## Outputting a random line from list.txt: `$ nicethings` + +# To-dos + +[ ] Only allow quoted messages to be added +[ ] Decentralize by allowing users to store their own +repository in their home folder