Skip to content

Commit 312594e

Browse files
committed
README tweaks
1 parent a20676a commit 312594e

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,27 @@ To cite OPS.js in publications please see [the zenodo record](https://zenodo.org
3131
3232
For Bibtex use:
3333

34-
>@misc{ian_dunlop_2015_21008,
35-
> author = {Ian Dunlop and
36-
> Egon Willighagen and
37-
> Elblood and
38-
> andrawaag and
39-
> Stian Soiland-Reyes and
40-
> PANDORINO},
41-
> title = {ops.js: OPS.js 6.1.2 for Open PHACTS 1.5 API},
42-
> month = jul,
43-
> year = 2015,
44-
> doi = {10.5281/zenodo.21008},
45-
> url = {http://dx.doi.org/10.5281/zenodo.21008}
46-
>}
34+
```latex
35+
@misc{ian_dunlop_2015_21008,
36+
author = {Ian Dunlop and
37+
Egon Willighagen and
38+
Elblood and
39+
andrawaag and
40+
Stian Soiland-Reyes and
41+
PANDORINO},
42+
title = {ops.js: OPS.js 6.1.2 for Open PHACTS 1.5 API},
43+
month = jul,
44+
year = 2015,
45+
doi = {10.5281/zenodo.21008},
46+
url = {http://dx.doi.org/10.5281/zenodo.21008}
47+
}
48+
```
4749

4850
You can get version information by using an OPS.js method in a browser or Node:
4951

50-
`new Version().information()`
52+
```javascript
53+
new Version().information()
54+
```
5155

5256
## Using the library
5357
If running in a browser based application use `src/combined.js`. With NodeJS use `npm install ops.js`.
@@ -60,7 +64,9 @@ Look at https://dev.openphacts.org for more information about the source methods
6064

6165
[Jasmine](http://pivotal.github.io/jasmine/ "Jasmine javascript testing framework") is used to test the ops.js api. The specs for the tests are in the 'test/spec' directory. To run them use jasmine-node like this:
6266

67+
```bash
6368
jasmine-node --config app_id your_app_id --config app_key your_app_key --config app_url https://beta.openphacts.org/1.5 test/spec/integration/
69+
```
6470

6571
### Testing with Docker
6672

@@ -71,8 +77,9 @@ Run with the `-it` parameter to get colour output.
7177
You might want to override environment variables like `app_url`, `app_id` and `app_key`.
7278
Example:
7379

74-
docker run -it -e app_url=http://heater.cs.man.ac.uk:3002 openphacts/ops-api-test
75-
80+
```bash
81+
docker run -it -e app_url=http://heater.cs.man.ac.uk:3002 openphacts/ops-api-test
82+
```
7683

7784

7885
## API call examples:

0 commit comments

Comments
 (0)