From 52f7fd302d10038b8ab07da625d1eef7bd9c7e58 Mon Sep 17 00:00:00 2001 From: Hugh Rundle Date: Sun, 18 Jun 2023 19:22:15 +1000 Subject: [PATCH] update docs --- README.md | 5 +++-- docs/install.md | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 709a296..0c85ad0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # ๐Ÿฅณ ==> ๐Ÿงผ ==> ๐Ÿ˜‡ -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) **ephemetoot** is a Python command line tool for deleting old toots. +As Mastodon now has similar functionality built in, `ephemetoot` is now in maintenance mode - no new features will be added, only security updates. + ## 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) @@ -48,7 +49,7 @@ You can use `ephemetoot` to delete [Mastodon](https://github.com/tootsuite/masto ## Contributing ephemetoot is tested using `pytest`. -For all bugs, suggestions, pull requests or other contributions, please check the [contributing guide](./docs/contributing.md). +For bugs or other contributions, please check the [contributing guide](./docs/contributing.md). ## License This project and all contributions are [licensed](./LICENSE) under the GPL 3.0 or future version diff --git a/docs/install.md b/docs/install.md index 788d463..ce81731 100644 --- a/docs/install.md +++ b/docs/install.md @@ -62,6 +62,7 @@ Calling `--init` will save your configuration file as `config.yaml` in the curre | base_url | **required** - The base url of your Mastodon server, without the 'https://'. e.g. `ausglam.space`| | days_to_keep | Number of days to keep toots e.g. `30`. If no value is provided the default number is 365 | | keep_pinned | Either `true` or `false` - if `true`, any pinned toots will be kept regardless of age | +| boosts_only | Either `true` or `false`. | | toots_to_keep | A list of toot ids indicating toots to be kept regardless of other settings. The ID of a toot is the last part of its individual URL. e.g. for [https://ausglam.space/@hugh/101294246770105799](https://ausglam.space/@hugh/101294246770105799) the id is `101294246770105799` | | hashtags_to_keep | A list of hashtags, where any toots with any of these hashtags will be kept regardless of age. Do not include the '#' symbol. Do remember the [rules for hashtags](https://docs.joinmastodon.org/user/posting/#hashtags) | | visibility_to_keep | Toots with any of the visibility settings in this list will be kept regardless of age. Options are: `public`, `unlisted`, `private`, `direct`. | @@ -83,4 +84,4 @@ As of version 2, you can use a single `ephemetoot` installation to delete toots * [Home](index.md) * [Options](options.md) * [Upgrading and uninstalling](upgrade.md) -* [Contributing](contributing.md) \ No newline at end of file +* [Contributing](contributing.md)