@faa-aviation-data-portal/aeronav-charts - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "@faa-aviation-data-portal/aeronav-charts",
   "description": "Fetch links and metadata for charts provided by Aeronav in a sane format.",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "author": {
@@ -6,0 +6,0 @@ "name": "Forrest Desjardins",

readme.md

 # aeronav-charts
 
 Fetch links and metadata for charts provided by Aeronav in a sane format.
+
+[![NPM Version][npm-image]][npm-url]
+
+## Installation
+
+```console
+$ npm install --save @faa-aviation-data-portal/aeronav-charts
+```
+
+## Usage
+
+```js
+const aeronavCharts = require('@faa-aviation-data-portal/aeronav-charts')
+
+aeronavCharts.vfr.sectionals().then(results => {
+  console.log(results[2])
+})
+```
+
+### Output
+
+```js
+{
+  chartName: 'Atlanta',
+  currentEdition: {
+    sequenceNumber: 102,
+    releaseDate: 'Feb 28 2019',
+    geotiff: 'https://aeronav.faa.gov/content/aeronav/sectional_files/Atlanta_102.zip',
+    pdf: 'https://aeronav.faa.gov/content/aeronav/sectional_files/PDFs/Atlanta_102_P.pdf'
+  },
+  nextEdition: {
+    sequenceNumber: 103,
+    releaseDate: 'Aug 15 2019',
+    geotiff: 'https://aeronav.faa.gov/content/aeronav/sectional_files/Atlanta_103.zip',
+    pdf: 'https://aeronav.faa.gov/content/aeronav/sectional_files/PDFs/Atlanta_103_P.pdf'
+  }
+}
+```
+
+See `./example.js` for more examples.
+
+## API
+
+### VFR Charts
+
+#### `aeronavCharts.vfr.sectionals()`
+#### `aeronavCharts.vfr.terminalArea()`
+#### `aeronavCharts.vfr.helicopter()`
+#### `aeronavCharts.vfr.grandCanyon()`
+#### `aeronavCharts.vfr.planning()`
+#### `aeronavCharts.vfr.caribbean()`
+
+### IFR Charts
+
+#### `aeronavCharts.vfr.lowsHighsAreas()`
+#### `aeronavCharts.vfr.planning()`
+#### `aeronavCharts.vfr.gulf()`
+
+## Contributing
+
+Contributions welcome!
+
+## License
+
+MIT © [Forrest Desjardins](https://github.com/fdesjardins)
+
+[npm-url]: https://www.npmjs.com/package/@faa-aviation-data-portal/aeronav-charts
+[npm-image]: https://img.shields.io/npm/v/@faa-aviation-data-portal/aeronav-charts.svg?style=flat

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9079

increased by21.2%

Number of lines in readme file

72

increased by1700%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes