bitbot-3.11-fork/README.md

# BitBot
Python3 event-driven modular IRC bot!

## Setup

### Requirements
`$ pip3 install --user -r requirements.txt`

### Config
See [docs/help/config.md](docs/help/config.md).

### Backups
If you wish to create backups of your BitBot instance (which you should, [borgbackup](https://borgbackup.readthedocs.io/en/stable/) is a good option), I advise backing up the entirety of `~/.bitbot` - where BitBot by-default keeps config files, database files and rotated log files.

## Github, Gitea and GitLab web hooks
I run BitBot as-a-service on most popular networks (willing to add more networks!) and offer github/gitea/gitlab webhook to IRC notifications for free to FOSS projects. Contact me for more information!

## Contact/Support
Come say hi at `#bitbot` on irc.libera.chat

## License
This project is licensed under GNU General Public License v2.0 - see [LICENSE](LICENSE) for details.
first commit. 2016-03-29 11:56:58 +00:00			`# BitBot`
			`Python3 event-driven modular IRC bot!`

make "Setup" a whole category of README.md 2019-12-06 17:09:22 +00:00			`## Setup`

			`### Requirements`
add "$" to command in README.md to make it more obvious that it's a command 2019-10-09 13:01:15 +00:00			`$ pip3 install --user -r requirements.txt`
first commit. 2016-03-29 11:56:58 +00:00
make "Setup" a whole category of README.md 2019-12-06 17:09:22 +00:00			`### Config`
			`See [docs/help/config.md](docs/help/config.md).`
first commit. 2016-03-29 11:56:58 +00:00
make "Setup" a whole category of README.md 2019-12-06 17:09:22 +00:00			`### Backups`
remove database_backup.py, add note in README.md about what should be backed up 2019-12-06 17:07:25 +00:00			If you wish to create backups of your BitBot instance (which you should, [borgbackup](https://borgbackup.readthedocs.io/en/stable/) is a good option), I advise backing up the entirety of `~/.bitbot` - where BitBot by-default keeps config files, database files and rotated log files.

better README.md webhook wording 2019-10-18 12:22:25 +00:00			`## Github, Gitea and GitLab web hooks`
			`I run BitBot as-a-service on most popular networks (willing to add more networks!) and offer github/gitea/gitlab webhook to IRC notifications for free to FOSS projects. Contact me for more information!`
Add section about github web hooks to README.md 2019-01-19 15:56:10 +00:00
Add link to irc.freenode.net##bitbot to README.md 2018-10-26 10:38:46 +00:00			`## Contact/Support`
freenode is dead long live libera.chat 2021-05-25 17:43:17 +00:00			Come say hi at `#bitbot` on irc.libera.chat
add license to readme email placeholder (<email>) will need set or may be removed if not wanted 2019-05-26 16:03:05 +00:00
			`## License`
slim down license in README.md 2019-09-25 17:34:04 +00:00			`This project is licensed under GNU General Public License v2.0 - see [LICENSE](LICENSE) for details.`