From 8f8982c4489a058bfddebafb5715e3f99d72a77a Mon Sep 17 00:00:00 2001 From: Ari Lazier Date: Tue, 12 Jan 2016 11:02:30 -0800 Subject: [PATCH] Create README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..30ae7900 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Realm Object Store + +Cross-platform code used accross bindings. Binding developers can choose to use some or all the included functionality +- `object_store`/`schema`/`object_schema`/`property` - contains the structures and logic used to setup and modify realm files and their schema. +- `shared_realm` - wraps the object_store apis to provide transactions, notifications, realm caching, migrations, and other higher level functionality. +- `object_accessor`/`results`/`list` - accessor classes, object creation/update pipeline, and helpers for creating platform specific property getters and setters. +- `parser`/`query_builder` - cross platform query parser and query builder - requires and object_accessor specialization for argument support. Depends on https://github.com/ColinH/PEGTL + +## Building + +TBD + +## Testing + +TBD