docs: add API section

dvajs · Dec 30, 2016 · e28915c · e28915c
1 parent b8d20ac
commit e28915c
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,15 @@ const benjy = modelExtend(human, {
 });
 ````
 
+## API
+
+### modelExtend(...models) => Model
+
+Behaviour:
+* The `model.namespace` will be overrided by latter model.
+* `model[state|subscriptions|effects|reducers]` will be merged as `Object.assign`.
+* `model.state` will be overrided be latter model if it isn't an object.
+
 ## License
 
 MIT