diff --git a/README.md b/README.md index ef3fd2f..31533d4 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,33 @@ # nicethings + A Python program to be used on shared unix servers to cheer people up (A little program for [tilde.town](https://tilde.town)) # To-dos -- [ ] Only allow quoted messages to be added -- [ ] Decentralize by allowing users to store their own -repository in their home folder + +- [ ] Decentralize by adding to and pulling from a text file in a user's home directory + + +# Table of Contents + +- [How it works](#how-it-works) +- [Usage](#usage) + - [Adding a message to the file:](#adding-a-message-to-the-file) + - [Outputting a random line from list.txt:](#outputting-a-random-line-from-listtxt) + + # 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 + +Currently, a user can only add and output nice things to and from a list.txt located in m455's directory + ## Adding a message to the file: + `$ nicethings "insert your message here"` ## Outputting a random line from list.txt: + `$ nicethings`