initial revision of the api

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2012 Aaron Powell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,4 +1,51 @@
 db.js
 =====
 
-db.js is a wrapper for IndexedDB to make it easier to work against
+db.js is a wrapper for [IndexedDB](http://www.w3.org/TR/IndexedDB/) to make it easier to work against, making it look more like a queryable API.
+
+Usage
+====
+
+Add a reference to db.js in your application before you want to use IndexedDB:
+
+	<script src='/scripts/db.js'></script>
+
+Once you have the script included you can then open connections to each different database within your application:
+
+	var server;
+	db.open( 'my-db' , 1 , {
+		people: {
+			key: {
+				keyPath: 'id',
+				autoIncrement: true				
+			}
+		}
+	}, function ( s ) {
+		server = s;
+		//connection is open and ready for use
+	});
+
+A connection is intended to be persisted and you can perform multiple operations while it's kept open. Check out the `/tests/public/spec` folder for more examples.
+
+## Adding items
+
+	server.add( 'people' , {
+		firstName: 'Aaron',
+		lastName: 'Powell'
+	} , function ( item ) {
+		//item stored
+	});
+
+## Removing
+
+TODO
+
+## Querying
+
+TODO
+
+# License
+
+The MIT License
+
+Copyright (c) 2012 Aaron Powell

project.sublime-project

@@ -0,0 +1,8 @@
+{
+	"folders":
+	[
+		{
+			"path": "/D/_Projects/github/db.js"
+		}
+	]
+}