Skip to content

Commit 9420c1c

Browse files
committed
docs: update readme
1 parent 9cfcf16 commit 9420c1c

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,34 @@ API documentation is available at [http://workfront.github.io/workfront-api/](ht
3838
A number of examples can be found under [examples](examples) directory. It includes examples for both [node](examples/node) and [browser](examples/browser) environments.
3939
In order to run these examples clone a copy of workfront-api repository:
4040

41-
git clone git://github.com/Workfront/workfront-api.git
41+
```shell script
42+
git clone git://github.com/Workfront/workfront-api.git
43+
```
4244

4345
#### Running [node](examples/node) examples
4446

4547
First enter into `workfront-api` directory and install all the dependencies:
4648

47-
48-
cd workfront-api
49-
npm install
49+
```
50+
cd workfront-api
51+
yarn
52+
```
5053

5154
Use `node` to run the examples. For examples:
5255

53-
node examples/node/get-user-count.js
56+
```
57+
node examples/node/get-user-count.js
58+
```
5459

5560
Each example script outputs all its results into console and contains comments in the source code explaining what is happening in more details.
5661

5762
#### Running [browser](examples/browser) examples
5863

5964
To start supplied webserver type:
6065

61-
npm start
66+
```shell script
67+
npm start
68+
```
6269

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

@@ -70,11 +77,11 @@ We welcome contributions of all kinds from anyone. It can be either new example
7077

7178
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:
7279

73-
1. **Use the GitHub issue search** — check if the issue has already been
74-
reported.
75-
2. **Isolate the problem** — ideally create a [reduced test
76-
case](https://css-tricks.com/reduced-test-cases/).
77-
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.
80+
1. **Use the GitHub issue search** — check if the issue has already been
81+
reported.
82+
1. **Isolate the problem** — ideally create a [reduced test
83+
case](https://css-tricks.com/reduced-test-cases/).
84+
1. 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.
7885

7986
### Feature requests
8087

0 commit comments

Comments
 (0)