summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorJamie Matthews <[email protected]>2010-02-11 01:27:10 +0000
committerJamie Matthews <[email protected]>2010-02-11 01:27:10 +0000
commit7fe81fe1ec787b6f04922cc052f093353bbcbf50 (patch)
tree29eaa0cc410d63018553bc53c8449809ccbd57fc /README.markdown
parentb205ee73b08d866a6e261bc2d631e893af4c2726 (diff)
Added feature list and TODO
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 73a4d23..6de03ce 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,8 +1,28 @@
Idiorm
======
+** Version 0.1 - Alpha **
+
An lightweight nearly-zero-configuration object-relational mapper and fluent query builder for PHP5.
+Features
+--------
+
+* Makes simple queries and simple CRUD operations completely painless.
+* Gets out of the way when more complex SQL is required.
+* Built on top of [PDO](http://php.net/pdo).
+* Uses [prepared statements](http://uk.php.net/manual/en/pdo.prepared-statements.php) throughout to protect against [SQL injection](http://en.wikipedia.org/wiki/SQL_injection) attacks.
+* Requires no model classes, no XML configuration and no code generation: works out of the box, given only a connection string.
+* Database agnostic (untested).
+
+TODO
+----
+
+* Implement raw queries.
+* Improve documentation.
+* Proper testing.
+* More features.
+
Philosophy
----------