Added README.md
This commit is contained in:
pare
b7c491391f
commit
f9a94f8774
S'han modificat 1 arxius amb 23 adicions i 0 eliminacions
23
README.md
Normal file
23
README.md
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
# Welcome
|
||||||
|
This bot welcomes your Mastodon server new users and post registering evolution hourly, daily and weekly.
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
- **Python 3**
|
||||||
|
- Postgresql server
|
||||||
|
- Mastodon running server
|
||||||
|
- Mastodon server's Bot account
|
||||||
|
|
||||||
|
### Usage:
|
||||||
|
|
||||||
|
Within Python Virtual Environment:
|
||||||
|
|
||||||
|
1. Run `pip install -r requirements.txt` to install needed libraries.
|
||||||
|
|
||||||
|
2. Run `python db-setup.py` to setup and create new Postgresql database and needed tables in it.
|
||||||
|
|
||||||
|
3. Run `python setup.py` to get your bot's access token of your Mastodon or Pleroma server existing account. It will be saved to 'secrets/secrets.txt' for further use.
|
||||||
|
|
||||||
|
4. Run `python welcome.py` to get all peers from your host and the whole world of fediverse's servers (or almost the whole world).
|
||||||
|
|
||||||
|
5. Use your favourite scheduling method to set `python welcome.py` to run every minute.
|
Loading…
Referencia en una nova incidència