From 3a417440a5b8e0e579b18eb522135d40630715f1 Mon Sep 17 00:00:00 2001 From: AJ ONeal Date: Mon, 21 Sep 2015 20:14:26 -0600 Subject: [PATCH] add README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b6c562 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +Master Quest +------------ + +An ORM for multi-master applications. + +It is assumed that relationships are tight and therefore should be prefetched and that data is often added, +but rarely updated (append/log-style over traditional update style). + +API +--- + +* save(data) - creates or updates based on presence of ID +* upsert(id, data) - creates or updates based on existence in DB +* destroy(id) - deletes from DB +* get(id) - grab one by id +* find(attrs, opts) - grab many by indexable attributes + * opts.orderBy + * opts.orderByDesc + +maybe? + +* where(sql, vals) - WHERE