diff --git a/README.md b/README.md index 77bdbd8..5a3073d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ Shreddit +======= + +YAML Upgrade ----------- ---- -Note! The latest version uses YAML format over the old simpleconfigparser! -This means you'll have to migrate your config file to yaml! +**Note! Important! The latest version uses YAML format over the old simpleconfigparser! +This means you'll have to migrate your config file to yaml!** + +Description +----------- Shreddit is a Python command line program which will take a user's post history on the website Reddit (http://reddit.com) and after having the user edit a config file will systematically go through the user's history deleting one post/submission at a time until only those whitelisted remain. Note: When it became known that post edits were *not* saved but post deletions *were* saved code was added to edit your post prior to deletion. In fact you can actually turn off deletion all together and just have lorem ipsum (or a message about Shreddit) but this will increase how long it takes the script to run as it will be going over all of your messages every run!