@ulrik.ek/wgs84 1.0.0 → 1.0.1

package/README.md

@@ -1,4 +1,4 @@
-# @uek/wgs84
+# wgs84
 
 ## Introduction
 
@@ -7,48 +7,44 @@ A tiny library fully implemented in Typescript to handle WGS84 coordinates in Ge
 -   Parses and gives output in GeoJson using the [Point definition](https://en.wikipedia.org/wiki/GeoJSON). If you already have imported the typescript definition for Point in the geojson package you can use that (that is what I do in unit testing). Otherwise you can import `Point` from this package.
 -   No dependencies to other NPM modules.
 -   The math is based on [Aviation Formulary V1.47 by Ed Williams](https://edwilliams.org/avform147.htm#flat).
--   Functions will throw `Error` if fed impossible values, e.g. incorrectly formatted GeoJSON or lat >= 90 degrees (math will not work!). Make sure to handle that!
+-   Functions will throw `Error` if fed impossible values, e.g. incorrectly formatted GeoJSON or lat >= 90 degrees (math will not work!). _Make sure to handle that!_
 
 ## Getting Started
 
 Include in your project as any other NPM package
 
-> npm install @uek/wgs84
+> npm install @ulrik.ek/wgs84
 
 ## Usage
 
 ```typescript
-import {
-    bearing,
-    distance,
-    distanceEast,
-    distanceNorth,
-    distanceUp,
-    point,
-    Point,
-    pointEast,
-    pointNorth,
-    pointUp
-} from '@UEk/wgs84';
+import * as wgs84 from '@ulrik.ek/wgs84';
 
 // helper function to construct a GeoJSON Point
 const lat = 15;
 const lon = 25;
-const p: Point = point(lat, lon);
+const p: wgs84.Point = wgs84.point(lat, lon);
 
 // Getting a new point 100m north and 200m east of the first point
-const p1: Point = pointEastOf(pointNorth(p, 100), 200);
+const p1: wgs84.Point = wgs84.pointEastOf(wgs84.pointNorthOf(p, 100), 200);
 const newLat = p1.coordinates[1]; // GeoJSON uses [lon, lat] order!
 const newLon = p1.coordinates[0];
+console.log(`lat=${newLat}, lon=${newLon}`);
 
 // get the distance along north between the 2 points
-assert(distanceNorth(p, p1) === 100);
-assert(distanceNorth(p1, p) === -100);
+console.log(`distance along north=${wgs84.distanceNorth(p, p1)}`);
+console.log(`distance along east=${wgs84.distanceEast(p, p1)}`);
 ```
 
+This will produce the following output
+
+> lat=15.000903761214213, lon=25.001859599546577
+> distance along north=99.99999999991357
+> distance along east=200.00084005143466
+
 ## Documention
 
-[Typedoc](doc\)
+[Typedoc](https://github.com/UEk/wgs84/blob/main/doc/modules.md)
 
 # Build and Test
 

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@ulrik.ek/wgs84",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "Basic library for computing small distances between WGS84 coordinates using a flat earth approximation.",
-    "author": "Ulrik E",
+    "author": "Ulrik E.",
     "license": "MIT",
     "main": "dist/index.js",
     "directories": {
@@ -20,6 +20,7 @@
         "clean": "npx shx rm -rf ./coverage/ ./report/ ./dist/",
         "build": "tsc --build tsconfig.json",
         "test": "npm run clean && npx jest --clearCache && jest --verbose --coverage --color --modulePathIgnorePatterns=./dist/ && npm run build",
+        "run_example": "npx ts-node example/index.ts",
         "type_doc": "npx typedoc --plugin typedoc-plugin-markdown --out doc src/index.ts --excludeNotDocumented"
     },
     "devDependencies": {