updated readme

cleanup
m455 2020-01-20 14:17:21 -05:00
parent 009b9c5f78
commit 9660848cd1
1 changed files with 19 additions and 3 deletions

View File

@ -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
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
# 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)
<!-- markdown-toc end -->
# 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`