Merge pull request #149 from renderforest/update-endpoints

✨ release 0.3.8
renderforest · Feb 8, 2019 · 198f41e · 198f41e
2 parents 108d43d + 611c0a0
commit 198f41e
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -208,15 +208,16 @@ renderforest.deleteProject(payload)
 ### Delete Specific Project Videos
 
 Deletes specific project videos.
-The quality parameter is optional. If you want to delete only a single quality video, you have to specify quality parameter, otherwise all quality videos of the project will be deleted.
+The quality parameter is optional.
+IMPORTANT: If you want to delete only a single quality video, you have to specify quality parameter, otherwise all quality videos of the project will be deleted.
 ```js
 const Renderforest = require('@renderforest/sdk-node')
 
 const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
   projectId: 5000658,
-  quality: 360
+  quality: 360 // optional argument
 }
 renderforest.deleteProjectVideos(payload)
   .then(console.log) // handle the success
@@ -271,7 +272,8 @@ const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
   projectId: 5000658,
-  quality: 1080
+  quality: 360,
+  watermark: 'https://example.com/watermark.png' // optional argument
 }
 renderforest.renderProject(payload)
   .then(console.log) // handle the success

diff --git a/examples/projects/delete-project-videos.js b/examples/projects/delete-project-videos.js
@@ -12,7 +12,7 @@ const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
   projectId: 5000658,
-  quality: 360
+  quality: 360 // optional argument
 }
 renderforest.deleteProjectVideos(payload)
   .then(console.log) // handle the success

diff --git a/examples/projects/render-project.js b/examples/projects/render-project.js
@@ -13,7 +13,7 @@ const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 const payload = {
   projectId: 5000658,
   quality: 360,
-  watermark: 'watermarkURL'
+  watermark: 'https://example.com/watermark.png' // optional argument
 }
 renderforest.renderProject(payload)
   .then(console.log) // handle the success

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.7",
+  "version": "0.3.8",
   "author": "RenderForest LLC",
   "bugs": {
     "url": "https://github.com/renderforest/renderforest-sdk-node/issues"