You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-22Lines changed: 14 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,35 +7,33 @@
7
7
8
8
A client for Workfront API which can be used in both server (NodeJS) and client (browsers).
9
9
10
-
If used in browser environment you may need to polyfill Promises (see ES6 Promise for polyfills) and fetch ([whatwg-fetch](https://github.com/fis-components/whatwg-fetch)).
10
+
If used in browser environment you may need to polyfill Promises (see ES6 Promise for polyfills) and fetch ([whatwg-fetch](https://github.com/fis-components/whatwg-fetch)).
11
11
12
12
## Usage
13
13
14
14
#### Server-side
15
15
16
16
Install as a dependency:
17
-
18
-
npm install --save workfront-api
19
-
17
+
npm install --save workfront-api
20
18
Then `require('workfront-api')` in your code. For example:
19
+
21
20
```javascript
22
21
var Workfront =require('workfront-api'),
23
-
util =require('util');
22
+
util =require('util')
24
23
25
24
/**
26
25
* The console.log statement below will output the following:
27
-
* {
26
+
* {
28
27
* Api: [Function: Api]
29
28
* }
30
29
*/
31
-
console.log(util.inspect(Workfront, {depth:0}));
30
+
console.log(util.inspect(Workfront, {depth:0}))
32
31
```
33
32
34
33
## Documentation
35
34
36
35
API documentation is available at [http://workfront.github.io/workfront-api/](http://workfront.github.io/workfront-api/).
37
36
38
-
39
37
## Examples
40
38
41
39
A number of examples can be found under [examples](examples) directory. It includes examples for both [node](examples/node) and [browser](examples/browser) environments.
@@ -64,24 +62,24 @@ To start supplied webserver type:
64
62
65
63
Visit [http://localhost:8000/examples/browser/](http://localhost:8000/examples/browser/) to see list of all examples available for browser.
66
64
67
-
68
65
## Contributing
69
66
70
67
We welcome contributions of all kinds from anyone. It can be either new example or fix or documentation improvement. Please read these guidelines:
71
68
72
69
### Bug Reports
70
+
73
71
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you! Please make sure to check these points to make a good bug report:
74
72
75
-
1.**Use the GitHub issue search**— check if the issue has already been
76
-
reported.
77
-
2.**Isolate the problem**— ideally create a [reduced test
0 commit comments