1.0.3

Author: trickypr

.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [8.x, 12.x, 13.x]
+        node-version: [10.x, 12.x, 13.x]
         os: 
         - ubuntu-latest
         - windows-latest

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2019-11-7 
+### Added 
+ - `getObservationsWMO` function 
+ - `getObservationsBOMID` function
+ - `getForecastFromDescription` function
+ - `getForecast` function
+ - `States` Enum
+ - `IGlobalLocation` interface
+ - `IForecast` interface 
+ - `IPlaceForecasts` interface
+ - `IObservation` interface
+ - Add an ftp handler with a cache
+
+## [1.0.1] - 2019-11-8
+### Changes
+ - Include typescript in the npm package
+
+## [1.0.2] - 2019-11-12
+### Added
+ - Changelog
+
+### Changes
+ - Increase compile target from `ES2017` to `ES2018`
+ - Update typescript, @typescript-eslint/parser and @typescript-eslint/eslint-plugin
+ - Update `README.md` to be more helpful
+ - NPM home page
+
+### Removed
+ - Removed support for node 8. Oldest supported version is node 10.

README.md

@@ -1,2 +1,44 @@
-# bomjs
-A wrapper over the Australian Bureau of Meteorology api
+<h1 align="center">BomJS</h1>
+<p align="center">A wrapper over the Australian Bureau of Meteorology api</p>
+<div align="center">
+  <img src="https://img.shields.io/node/v/bomjs?style=flat-square" alt="Node version" />
+  <img alt="npm (tag)" src="https://img.shields.io/npm/v/bomjs/latest?style=flat-square">
+</div>
+
+<p align="center"><a href="https://trickypr.github.io/bomjs/">Docs</a> • <a href="https://www.npmjs.com/package/bomjs">NPM</a> • <a href="https://github.com/trickypr/bomjs">Github</a></p>
+
+## Install
+```sh
+yarn add bomjs
+# or
+npm install bomjs
+```
+
+## Grab some observations
+```ts
+import { getObservationsWMO, getObservationsBOMID, IObservation, States } from '../dist/app'
+
+// WMO
+const data: IObservation = await getObservationsWMO(94768, States.NSW)
+
+// BOM ID
+const data: IObservation = await getObservationsBOMID(69017, States.NSW)
+```
+
+## Grab forecasts
+```ts 
+import { getForecastFromDescription, getForecast, States } from '../build/app'
+
+// From description
+const forecast: IForecast = await getForecastFromDescription('canberra', States.NSW)
+
+// From forecast id
+const forecast: IForecast = await getForecast('NSW_PW012', States.NSW)
+```
+
+## Changelog 
+- 1.0.0: Inital release
+- 1.0.1: Include typescript in the npm bundle
+- 1.0.2: Better docs for npm, and increase the build to `ES2018`
+
+A more detailed change log is available on [the github repo](https://github.com/trickypr/bomjs/blob/master/CHANGELOG.md).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bomjs",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A wrapper over the Australian Bureau of Meteorology api",
   "main": "build/app.js",
   "scripts": {
@@ -12,6 +12,9 @@
     "docs:dev": "vuepress dev docs",
     "docs:build": "vuepress build docs"
   },
+  "engines": {
+    "node": ">=10.0.0"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/trickypr/bomjs.git"
@@ -21,15 +24,15 @@
   "bugs": {
     "url": "https://github.com/trickypr/bomjs/issues"
   },
-  "homepage": "https://github.com/trickypr/bomjs#readme",
+  "homepage": "https://trickypr.github.io/bomjs/",
   "devDependencies": {
     "@types/ftp": "^0.3.29",
     "ghooks": "^2.0.4",
-    "@typescript-eslint/eslint-plugin": "^2.6.1",
-    "@typescript-eslint/parser": "^2.6.1",
+    "@typescript-eslint/eslint-plugin": "^2.7.0",
+    "@typescript-eslint/parser": "^2.7.0",
     "ava": "^2.4.0",
     "eslint": "^6.6.0",
-    "typescript": "^3.6.4",
+    "typescript": "^3.7.2",
     "vuepress": "^1.2.0"
   },
   "dependencies": {

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     /* Basic Options */
-    "target": "ES2017",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
+    "target": "ES2018",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     // "lib": [],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */