Update readme with AUR and remove github actions mentions
This commit is contained in:
parent
3314320f65
commit
e61b438263
1 changed files with 9 additions and 11 deletions
20
README.md
20
README.md
|
@ -1,14 +1,20 @@
|
|||
# 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.
|
||||
|
||||
## 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
|
||||
### Initial setup
|
||||
Only once
|
||||
|
||||
```bash
|
||||
python -m pip install cleantoots
|
||||
cleantoots config setup # See the following section for config file options
|
||||
cleantoots config login
|
||||
```
|
||||
|
@ -109,13 +115,5 @@ cleantoots config edit
|
|||
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
|
||||
The idea behind cleantoots is highly inspired by [magnusnissel/cleantweets](https://github.com/magnusnissel/cleantweets).
|
||||
|
|
Loading…
Reference in a new issue