@pixwel/pixwel-sdk 1.1.11 → 2.1.0

package/.babelrc

@@ -1,3 +1,4 @@
 {
-  "presets": ["env"]
+	"presets": ["env"],
+	"plugins": ["transform-runtime"]
 }

package/README.md

@@ -0,0 +1,60 @@
+# PIXWEL-SDK
+
+An overview of the Pixwel SDK.
+
+## Data Resources
+
+##### Saving a resource
+
+```
+let ingest = Ingest.find('a1b2c3');
+ingest.source = 'different.mov';
+ingest.save();
+```
+
+##### Validating a resource
+```
+let ingest = new Ingest({ source: 'cool.mov'});
+let bool = ingest.validate();
+let errors = ingest.errors();
+// returns
+```
+
+
+##### Getting data from a resource
+```
+let asset = new Asset({ name: 'Cool' });
+console.log(asset.name);
+let data = asset.data();
+```
+
+##### Cloning an existing resource
+```
+let project = Project.find('a1b2c3');
+let newProject = project.clone();
+```
+
+##### Registering a find callback
+```
+Model.registerCallback('find', result => {
+	updateRedux(result);
+});
+let res = Model.all();
+```
+
+##### Registering a save callback`
+```
+Model.registerCallback('save', res => {
+	updateRedux(res);
+});
+let model = new Model({ name: 'Jeff' });
+let res = model.save();
+```
+
+##### Handles API errors gracefully
+```
+let asset = new Asset();
+asset.save();
+// throws Exception
+// HTTP 400: POST https://api.pixwel.com/assets {}
+```