From 6d13618ad4400f1a1f14c87976f6a4cc74f0f9b2 Mon Sep 17 00:00:00 2001
From: Hugh Rundle <hugh@hughrundle.net>
Date: Mon, 7 Sep 2020 09:51:06 +1000
Subject: [PATCH] improve instructions

- README now has a 'quickstart' section
- config file creation clarifies not to include the '#' in hashtag lists
---
 README.md                | 21 +++++++++++++++++++++
 ephemetoot/ephemetoot.py |  4 ++--
 2 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d86ca1e..a1078cd 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,27 @@
 
 **ephemetoot** is a Python command line tool for deleting old toots.
 
+## Quickstart
+
+You should have Python3 and pip installed, and an app access token on hand. More detail information is available in [the docs](https://ephemetoot.hugh.run)
+
+Install with pip:
+```shell
+pip install ephemetoot
+```
+Create a config file:
+```shell
+ephemetoot --init
+```
+Do a first run in `--test` mode:
+```shell
+ephemetoot --test
+```
+Find out about other options:
+```shell
+ephemetoot --help
+```
+
 ## Documentation
 * [Installation](./docs/install.md)
 * [Options](./docs/options.md)
diff --git a/ephemetoot/ephemetoot.py b/ephemetoot/ephemetoot.py
index a2e5400..8e54238 100644
--- a/ephemetoot/ephemetoot.py
+++ b/ephemetoot/ephemetoot.py
@@ -69,8 +69,8 @@ def init():
         conf_days = digit_input(tags, "Days to keep", "(default 365):")
         conf_pinned = yes_no_input(tags, "Keep pinned toots?")
         conf_keep_toots = optional_input(tags, "Toots to keep", "(optional list of IDs separated by commas):")
-        conf_keep_hashtags = optional_input(tags, "Hashtags to keep", "(optional list separated by commas):")
-        conf_keep_visibility = optional_input(tags, "Visibility to keep", "(optional list separated by commas):")
+        conf_keep_hashtags = optional_input(tags, "Hashtags to keep", "(optional list without '#' e.g. mastodon, gardening, cats):")
+        conf_keep_visibility = optional_input(tags, "Visibility to keep", "(optional list e.g. 'direct'):")
         conf_archive = optional_input(tags, "Archive path", "(optional filepath for archive):")
 
         # write out the config file