Permalink
Browse files

more documentation

  • Loading branch information...
1 parent b923f07 commit a0ef630ef3555ecf81cf823c7080fbd76c64e5ac @weepy committed Mar 7, 2011
Showing with 1,027 additions and 215 deletions.
  1. +22 −1 LICENSE
  2. +27 −31 README.md
  3. +690 −0 docs/index.html
  4. +196 −94 lib/core.js
  5. +19 −19 lib/stores/memory.js
  6. +43 −43 lib/stores/redis.js
  7. +16 −18 lib/stores/rest.js
  8. +1 −1 lib/utils.js
  9. +5 −0 make_docs
  10. +3 −3 package.json
  11. +1 −1 test/lib/app.js
  12. +2 −2 test/test_memory.js
  13. +2 −2 test/test_rest.js
View
@@ -1 +1,22 @@
-https://github.com/weepy/kaffeine/raw/master/LICENSE
+Copyright (c) 2010 Jonah Fox
+
+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.
View
@@ -1,48 +1,44 @@
-MMODEL
-------
+MMMODEL
+======
+
+Homer Simpson's favorite Javascript ORM
+
+MMmodel is a Javascript ORM for Redis and client side use through a REST api.
-Mtask is a Javascript ORM for Redis and client side use through a REST api. It has multiple backends - using the same API. There's also a memory store.
+It has multiple backends - using the same API. There's also a memory store.
Structure
---
-There's a common Core with 3 stores (Redis, Memory and REST). Other's could easily be written.
+TBD
+Documentation
+----
-API
----
+See api in docs/index.html
-Core
----
+more to come
+
+Examples
+--------
+
+TBD
+
+Installation
+------
+
+npm install mmmodel
-var Task = Mmodel.create("Task", { ... })
-
-// We now have the following functions available to us in core
-
-new Task(attr, [sync])
-Task.load(attr)
-Task.create(attr, [callback])
-task.sync
-task.modified([prop])
-task.update(params, [callback]) {
-task.save([callback])
-task.error(str)
-task.destroy([callback])
-task.toJSON()
-task.in_error()
-task.merge(attr, [x])
-task.validate(callback)
-Task._setStore
-Task.load_multi(array)
-Task.bind = task.bind(ev, callback, async)
-Task.unbind = task.unbind(ev, callback)
-task.trigger(ev)
+Create Documenation
+-------
+./make_docs
+needs dox installed
Tests
----
To run the TDD tests:
<pre>
-expresso -s test/*
+expresso -s test/test_* -t 5000
</pre>
Oops, something went wrong. Retry.

0 comments on commit a0ef630

Please sign in to comment.