1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f7f938
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+weabot
+======
+weabot is a Python textboard and imageboard script made for Bienvenido a Internet BBS/IB. It's based on PyIB.
+
+New features
+------------
+- Textboards
+- Home page
+- Report system
+- Thread locking and permasaging
+- Mobile website
+- IDs
+- Noko
+- View and delete posts by IP
+- Oekaki
+- Flexible filetypes (such as Flash)
+- Wordfilters
+- Proper markdown and HTML
+- API
+- Many bugfixes and security improvements, and other minor improvements
+
+Requirements
+------------
+* Python 2.x
+* MySQL/MariaDB
+* MySQL-Python (MySQLdb)
+* WSGI/FastCGI (Optional)
+
+Installation
+------------
+1. Set up your web server to run Python scripts as CGI or FastCGI (see .htaccess example)
+2. Create a MySQL/MariaDB database and import the `weabot.sql` file
+3. Enter your database information and preferences in `cgi/settings.py`
+4. Navigate to http://yoursite.com/cgi/weabot.py/manage
+5. Log-in with credentials admin/admin - then create your own staff account and delete admin
+
+Authors
+-------
+weabot fork by Bienvenido a Internet N.P.O. <burocracia@bienvenidoainternet.org>    
+Original work by tslocum <tslocum@gmail.com> https://github.com/tslocum/PyIB
+
+License
+-------
+weabot is licensed under the AGPLv3, with portions under the GPLv3.
+If you run weabot, even on a web server, you must publish any changes of the source code, and under the same license.
+Please read the full text of the license for more details (LICENSE file).
+If you don't agree with the license terms, please choose one of the alternatives to weabot listed below.
+
+Alternatives
+------------
+Some alternatives to weabot are:
+
+* [Wakaba/Kareha](http://wakaba.c3.cx/s/web/wakaba_kareha)
+* [TinyIB](https://github.com/tslocum/TinyIB)
+* [Tinyboard](http://tinyboard.org/)
+* [PyIB](https://github.com/tslocum/PyIB)