improve instructions
- README now has a 'quickstart' section - config file creation clarifies not to include the '#' in hashtag lists
This commit is contained in:
parent
f25cc49ce1
commit
6d13618ad4
21
README.md
21
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)
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue