Skip to content

Commit d854bba

Browse files
committed
fix: improved docs
1 parent 2265cf7 commit d854bba

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ console.log(util.inspect(Workfront, {depth:0}));
3131

3232
#### In a browser
3333

34-
This package uses [Browserify](http://browserify.org) to generate [dist/workfront.min.js](dist/workfront.min.js). Loading that script will create `window.Workfront` object which will contain all the classes and methods just as in the server-side environment (see [Server-side](#server-side) section).
35-
This package makes use of [Promises](https://www.promisejs.org). Promises are not currently supported by all browsers (see [kangax compatibility tables](http://kangax.github.io/compat-table/es6/#Promise)), but there are many polyfills available, including one listed in [www.promisejs.org](https://www.promisejs.org). Load polyfill before `workfront.min.js` and everything will work just fine.
36-
Although the lack of CORS support may prevent you from sending request to Workfront servers, there are some usage examples in [examples/browser](examples/browser) folder to give you an idea.
34+
This package uses [Browserify](http://browserify.org) to generate [dist/workfront.min.js](dist/workfront.min.js). Loading that script will create `window.Workfront` object which will contain all the classes and methods just as in the server-side environment (see [Server-side](#server-side) section).
35+
This package makes use of [Promises](https://www.promisejs.org). Promises are not currently supported by all browsers (see [kangax compatibility tables](http://kangax.github.io/compat-table/es6/#Promise)), but there are many polyfills available, including one listed in [www.promisejs.org](https://www.promisejs.org). Load polyfill before `workfront.min.js` and everything will work just fine.
36+
Although the lack of CORS support may prevent you from sending request to Workfront servers, there are some usage examples in [examples/browser](examples/browser) folder to give you an idea.
3737
Note, that it is still possible to make use of this package in privileged environment such as browser extensions.
3838

3939

src/plugins/upload.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ module.exports = function(Api) {
2626
* Starting from version 2.0 API allows users to upload files.
2727
* The server will return the JSON data which includes 'handle' of uploaded file.
2828
* Returned 'handle' can be passed to create() method to create a new document.
29+
* This method is not available for browser execution environments and it is available only for Node.
2930
* @memberOf Workfront.Api
3031
* @param {fs.ReadStream} stream A readable stream with file contents
3132
* @param {Object} [overrides] Override the filename and content type (using keys

0 commit comments

Comments
 (0)