Skip to content

Commit 7ce33ef

Browse files
committed
Update README with some usage notes
1 parent d639ba7 commit 7ce33ef

File tree

4 files changed

+720
-9
lines changed

4 files changed

+720
-9
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,25 @@ Contains a pre-packaged copy of [grib2json](https://github.com/cambecc/grib2json
88

99
Data Vis demo here: http://danwild.github.io/wind-js-leaflet/
1010

11+
Note that this is intended as a crude demonstration, not intended for production use.
12+
To get to production; you should improve upon this or build your own.
13+
14+
## install, run:
15+
16+
(assumes you have node and npm installed)
17+
18+
```bash
19+
npm install
20+
npm start
21+
```
22+
23+
## endpoints
24+
- */latest* returns the most up to date JSON data available
25+
- */nearest* returns JSON data nearest to requested
26+
- $GET params:
27+
- `timeIso` an ISO timestamp for temporal target
28+
- `searchLimit` number of days to search beyond the timeIso (will search forwards/backwards)
29+
- */alive* health check url, returns simple message
30+
1131
## License
1232
MIT License (MIT)

app.js

+1-7
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,7 @@ var whitelist = [
1515
'http://localhost:63342',
1616
'http://localhost:3000',
1717
'http://localhost:4000',
18-
'http://danwild.github.io',
19-
'http://portal.ereefs.info',
20-
'http://52.65.8.160',
21-
'http://oa-21-mel.it.csiro.au',
22-
'https://oa-21-mel.it.csiro.au',
23-
'http://52.65.28.172',
24-
'http://lw.oznome.csiro.au:3000'
18+
'http://danwild.github.io'
2519
];
2620

2721
var corsOptions = {

0 commit comments

Comments
 (0)