1 files changed, 37 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1da26fc
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,37 @@
+## What is this?
+A simple bugtracker written in php.
+
+- Code uses PDO, so it should be able to use multiple db backends;
+- all tables given as postgresql tables, all queries tests on postgresql
+
+## Usage
+- See etc/ for sample config files
+- See etc/setup.sql for database setup
+
+## Source code guide
+
+### users
+ action |
+--------|--------
+ create | user/register.php
+ read   | user/index.php
+ update | user/update.php
+ delete | user/delete.php
+ login  | user/login.php
+ logout | user/logout.php
+
+## bugs
+
+### create
+### read
+### update
+### delete
+
+## reports
+
+### create
+### read
+### update
+### delete
+
+## index page