bitbot-3.11-fork/README.md

# BitBot
Python3 event-driven modular IRC bot!

## Requirements
Python3.6+ and [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4), [lxml](https://pypi.org/project/lxml/), [netifaces](https://pypi.org/project/netifaces/), [requests](https://pypi.org/project/requests/), [scrypt](https://pypi.python.org/pypi/scrypt), [suds](https://pypi.python.org/pypi/suds-jurko) and [tweepy](https://pypi.org/project/tweepy/). Use `pip3 install -r requirements.txt` to install them all at once.

## Setup
See [docs/help/setup.md](docs/help/setup.md).

## Github web hooks
I run BitBot as-a-service on most popular networks and offer github-to-IRC web hook notifications for free to FOSS projects. Contact me for more information!

## Contact/Support
Come say hi at [#bitbot on freenode](https://webchat.freenode.net/?channels=#bitbot)

## License
```
Copyright (C) 2019 jesopo <contact@jesopo.uk> - https://github.com/jesopo/bitbot

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
```
first commit. 2016-03-29 11:56:58 +00:00			`# BitBot`
			`Python3 event-driven modular IRC bot!`

Put minimum python version in README.md 2019-06-05 20:05:54 +00:00			`## Requirements`
our usage of BeautifulSoup requires lxml 2019-06-12 17:16:27 +00:00			Python3.6+ and [BeautifulSoup4](https://pypi.python.org/pypi/beautifulsoup4), [lxml](https://pypi.org/project/lxml/), [netifaces](https://pypi.org/project/netifaces/), [requests](https://pypi.org/project/requests/), [scrypt](https://pypi.python.org/pypi/scrypt), [suds](https://pypi.python.org/pypi/suds-jurko) and [tweepy](https://pypi.org/project/tweepy/). Use `pip3 install -r requirements.txt` to install them all at once.
first commit. 2016-03-29 11:56:58 +00:00
Add first version of docs/help/setup.md and link to it in README.md 2019-04-15 15:59:27 +00:00			`## Setup`
			`See [docs/help/setup.md](docs/help/setup.md).`
first commit. 2016-03-29 11:56:58 +00:00
Add section about github web hooks to README.md 2019-01-19 15:56:10 +00:00			`## Github web hooks`
typo, 'serivce' - 'service' 2019-05-30 21:40:45 +00:00			`I run BitBot as-a-service on most popular networks and offer github-to-IRC web hook 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`
'##bitbot' -> '#bitbot' in README.md 2019-02-18 16:30:11 +00:00			`Come say hi at [#bitbot on freenode](https://webchat.freenode.net/?channels=#bitbot)`
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`
Change README.md license to use backtick blockquote 2019-06-05 20:06:11 +00:00			```
			`Copyright (C) 2019 jesopo <contact@jesopo.uk> - https://github.com/jesopo/bitbot`

			`This program is free software; you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published by`
			`the Free Software Foundation; either version 2 of the License, or`
			`(at your option) any later version.`

			`This program is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`GNU General Public License for more details.`

			`You should have received a copy of the GNU General Public License along`
			`with this program; if not, write to the Free Software Foundation, Inc.,`
			`51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.`
			```