gaugendre/cleantoots
1
0
Fork 0
Code Issues 1 Pull requests Releases Activity

Update readme with AUR and remove github actions mentions

Browse source
This commit is contained in:
Gabriel Augendre 2020-11-21 08:32:32 +01:00
parent 3314320f65
commit e61b438263
No known key found for this signature in database
GPG key ID: 1E693F4CE4AEE7B4
1 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,14 +1,20 @@
# Cleantoots # Cleantoots
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FCrocmagnon%2Fcleantoots%2Fbadge&style=flat)](https://actions-badge.atrox.dev/Crocmagnon/cleantoots/goto)
Cleantoots helps you delete your old toots. Because not everything we say on social medias should stay there for eternity. Cleantoots helps you delete your old toots. Because not everything we say on social medias should stay there for eternity.
## Install
### Using pip
```bash
python -m pip install cleantoots
```
### ArchLinux package
An ArchLinux package is available, see the [AUR](https://aur.archlinux.org/packages/python-cleantoots/).
## Config ## Config
### Initial setup ### Initial setup
Only once Only once
```bash ```bash
python -m pip install cleantoots
cleantoots config setup # See the following section for config file options cleantoots config setup # See the following section for config file options
cleantoots config login cleantoots config login
``` ```
@ -109,13 +115,5 @@ cleantoots config edit
cleantoots config login cleantoots config login
``` ```
## Tested environments
Cleantoots test suite runs on Python 3.6, 3.7 and 3.8
on latest versions of macOS, Windows and Ubuntu as GitHub Actions understands it.
See
[the docs](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idruns-on)
for more information on what "latest" means.
## Inspiration ## Inspiration
The idea behind cleantoots is highly inspired by [magnusnissel/cleantweets](https://github.com/magnusnissel/cleantweets). The idea behind cleantoots is highly inspired by [magnusnissel/cleantweets](https://github.com/magnusnissel/cleantweets).