Skip to content

Commit

Permalink
chore: prettier and linter fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bhovhannes committed Jun 4, 2018
1 parent 5d2b8a4 commit 6b6de7e
Show file tree
Hide file tree
Showing 8 changed files with 1,078 additions and 968 deletions.
915 changes: 457 additions & 458 deletions CHANGELOG.md

Large diffs are not rendered by default.

36 changes: 14 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,33 @@

A client for Workfront API which can be used in both server (NodeJS) and client (browsers).

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)).
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)).

## Usage

#### Server-side

Install as a dependency:

npm install --save workfront-api

npm install --save workfront-api
Then `require('workfront-api')` in your code. For example:

```javascript
var Workfront = require('workfront-api'),
util = require('util');
util = require('util')

/**
* The console.log statement below will output the following:
* {
* {
* Api: [Function: Api]
* }
*/
console.log(util.inspect(Workfront, {depth:0}));
console.log(util.inspect(Workfront, {depth: 0}))
```

## Documentation

API documentation is available at [http://workfront.github.io/workfront-api/](http://workfront.github.io/workfront-api/).


## Examples

A number of examples can be found under [examples](examples) directory. It includes examples for both [node](examples/node) and [browser](examples/browser) environments.
Expand Down Expand Up @@ -64,24 +62,24 @@ To start supplied webserver type:

Visit [http://localhost:8000/examples/browser/](http://localhost:8000/examples/browser/) to see list of all examples available for browser.


## Contributing

We welcome contributions of all kinds from anyone. It can be either new example or fix or documentation improvement. Please read these guidelines:

### Bug Reports

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:

1. **Use the GitHub issue search** — check if the issue has already been
reported.
2. **Isolate the problem** — ideally create a [reduced test
case](https://css-tricks.com/reduced-test-cases/).
3. A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.
1. **Use the GitHub issue search** — check if the issue has already been
reported.
2. **Isolate the problem** — ideally create a [reduced test
case](https://css-tricks.com/reduced-test-cases/).
3. A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.

### Feature requests

Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
fits with the scope and aims of the project. It's up to _you_ to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.

Expand All @@ -93,23 +91,17 @@ Licensed under the Apache License, Version 2.0.
See the top-level file `LICENSE` and
(http://www.apache.org/licenses/LICENSE-2.0).


[license-image]: http://img.shields.io/badge/license-APv2-blue.svg?style=flat
[license-url]: LICENSE

[npm-url]: https://www.npmjs.org/package/workfront-api
[npm-version-image]: https://img.shields.io/npm/v/workfront-api.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/workfront-api.svg?style=flat

[travis-url]: https://travis-ci.org/Workfront/workfront-api
[travis-image]: https://img.shields.io/travis/Workfront/workfront-api.svg?style=flat

[codecov-url]: https://codecov.io/gh/Workfront/workfront-api
[codecov-image]: https://codecov.io/gh/Workfront/workfront-api/branch/master/graph/badge.svg

[code-climate-url]: https://codeclimate.com/github/Workfront/workfront-api
[code-climate-image]: https://img.shields.io/codeclimate/github/Workfront/workfront-api.svg?style=flat

[saucelabs-badge]: https://saucelabs.com/buildstatus/citizensas
[saucelabs-url]: https://saucelabs.com/beta/builds/1b8be6f71455499c82f02afc881e6c14
[saucelabs-matrix]: https://saucelabs.com/browser-matrix/citizensas.svg
[saucelabs-matrix]: https://saucelabs.com/browser-matrix/citizensas.svg
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"ts-loader": "4.3.1",
"tslib": "1.9.2",
"tslint": "5.10.0",
"tslint-config-prettier": "1.13.0",
"tslint-loader": "3.6.0",
"typedoc": "0.11.1",
"typescript": "2.9.1",
Expand Down
Loading

0 comments on commit 6b6de7e

Please sign in to comment.