metar-taf-parser 1.0.1 → 1.0.2

package/README.md

@@ -1,40 +1,36 @@
-# metar-taf-parser
+# ✈️ [metar-taf-parser](https://aeharding.github.io/metar-taf-parser)
 
 This is a port of [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) to Typescript. It's fully typed and tested with i18n support, and can run on Node or the browser.
 
-## Example
+[Check out the demo here](https://aeharding.github.io/metar-taf-parser)
 
-### Parse METAR
+## Installation
 
-```ts
-import { parseMetar } from 'metar-taf-parser'
+```sh
+yarn add metar-taf-parser
+# or
+npm i --save metar-taf-parser
+```
+
+## Usage
 
-// Get the raw METAR/TAF strings in your preferred way
-// For example: https://www.aviationweather.gov/dataserver
-// const { metar } = await myService.getAirportData('KMSN')
+### Parse a METAR
 
-// Readily serializable
-const metarResult = parseMetar(metar)
+```ts
+import { parseMetar } from 'metar-taf-parser'
 
-// Your code here 🚀
+const metar = parseMetar(rawMetarString)
 ```
 
-### Parse TAF
+### Parse a TAF
 
 ```ts
 import { parseTAF } from 'metar-taf-parser'
 
-// Get the raw METAR/TAF strings in your preferred way
-// For example: https://www.aviationweather.gov/dataserver
-// const { taf } = await myService.getAirportData('KMSN')
-
-// Readily serializable
-const tafResult = parseTAF(taf)
-
-// Your code here 🚀
+const taf = parseTAF(rawTAFString)
 ```
 
-### i18n
+## i18n
 
 ```ts
 import { parseMetar } from 'metar-taf-parser'
@@ -45,16 +41,16 @@ const { metar } = await myService.getAirportData('KMSN')
 const metarResult = parseMetar(metar, { locale: de })
 ```
 
-## Contributing
-
-This project is intended to provide feature parity with [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) and will only accept PRs to maintain feature parity or to fix inconsistencies with that project.
-
 ## Development
 
 ### Example site
 
 Please see [the example site README.md](example/README.md).
 
+## Contributing
+
+This project is intended to provide feature parity with [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser) and will only accept PRs to maintain feature parity or to fix inconsistencies with that project.
+
 ## Acknowledgment
 
 This software port was made possible due to the fantastic work of [@mivek](https://github.com/mivek) in [python-metar-taf-parser](https://github.com/mivek/python-metar-taf-parser). If you like this project, please [consider buying @mivek a coffee](https://ko-fi.com/mivek).

package/package.json

@@ -1,7 +1,16 @@
 {
   "name": "metar-taf-parser",
-  "version": "1.0.1",
-  "description": "Parse METAR and TAF files",
+  "version": "1.0.2",
+  "description": "Parse METAR and TAF reports",
+  "homepage": "https://aeharding.github.io/metar-taf-parser",
+  "keywords": [
+    "aviation",
+    "weather",
+    "metar",
+    "taf",
+    "report",
+    "deserialize"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "author": "Alexander Harding <2166114+aeharding@users.noreply.github.com>",
@@ -16,7 +25,7 @@
     "start": "node --experimental-specifier-resolution=node --loader ts-node/esm lib",
     "check-types": "tsc --noEmit",
     "check-formatting": "prettier --check '**/*.{js,json,css,md,scss,tsx,ts}'",
-    "watch": "watch 'yarn build' lib",
+    "watch": "watch 'yarn build' src",
     "test": "jest --coverage",
     "test-watch": "jest --watch --coverage",
     "prepublishOnly": "yarn build"