Merge pull request #133 from renderforest/add-docs-pushScreen

add-docs-pushScreen
renderforest · Dec 11, 2018 · 2a0c21a · 2a0c21a
2 parents 1a2b408 + 4fde8c0
commit 2a0c21a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,7 @@ Welcome to the Renderforest API! You can use our API to:
       - [Set video on video holder area](#set-video-on-video-holder-area)
       - [Set project colors](#set-project-colors)
       - [Set screens](#set-screens)  
+    * [Push Screen](#push-screen)
 * [Sounds API](#sounds-api)
   - [Get All Sounds](#get-all-sounds)
   - [Get Recommended Sounds](#get-recommended-sounds)
@@ -606,6 +607,11 @@ projectDataInstance.setScreens(_screens)
 
 #### Push screen
 
+Inserts new `screen`, arrange screens by `screen.order` property and normalize orders to have consequent numbers.
+In case `screen.order` is less than `0`, then inserts the new `screen` at the beginning of screens.
+If `screen.order` property is more than last `screen's` order property, then appends to the end of screens.
+Throws `MissingOrderError` if `screen.order` property is missing.
+
 ```js
 const _screens = projectDataInstance.pushScreen(screen) // Array of screens
 ```

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@renderforest/sdk-node",
   "description": "Renderforest SDK for Node.js",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "author": "RenderForest LLC",
   "bugs": {
     "url": "https://github.com/renderforest/renderforest-sdk-node/issues"