geo-lib - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

CHANGELOG.md

@@ -1,2 +0,5 @@
-* _2016-06-19_: Ok, first alpha version is ready to be tested. (HEAD -> master, origin/master) [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/4ad0a0b9dd1416842d4d81b46db10a266e05e1d5">view commit</a>
+* _2016-06-19_: Updated the main docs. (HEAD -> master, origin/master) [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/a171ffc59f861201b5fb9378e5b0daea43396d37">view commit</a>
+* _2016-06-19_: Added changelog. [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/f1129dce007cdaf9cff99dcc8050186d6d58fa6c">view commit</a>
+* _2016-06-19_: Bumped version. [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/3db04ea427e9afdd8e64822a69275d712aaf6559">view commit</a>
+* _2016-06-19_: Ok, first alpha version is ready to be tested. [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/4ad0a0b9dd1416842d4d81b46db10a266e05e1d5">view commit</a>
 * _2016-06-18_: Adding placeholders. [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/68f8917a32afea209189526e09900604556067b8">view commit</a>
@@ -3,0 +6,0 @@ * _2016-06-18_: Changed ref. [Øistein Sørensen] <a href="http://github.com/5orenso/geo-lib/commit/190ec5108fa762c865c05973eee8d1c0fa952903">view commit</a>

package.json

 {
   "name": "geo-lib",
   "description": "A Node.js module with useful geo functions. Made with performance in mind.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "homepage": "https://github.com/5orenso/geo-lib",
@@ -6,0 +6,0 @@ "repository": {

README.md

@@ -1,2 +0,2 @@
-# Boilerplate for your brand new Node.js module - NPM ready
+# Geo-lib module for fast calculations of distance, speed and heading
 
@@ -6,16 +6,62 @@ [![Build Status](https://travis-ci.org/5orenso/geo-lib.svg?branch=master)](https://travis-ci.org/5orenso/geo-lib)
 
-Placeholder for my new geo-lib module. This is going to be a useful Node.js module built with performance and speed as 
-priority one.
+The start of my new geo-lib module. This Node.js module is built with performance and speed as priority one. 
 
+Why did I start this module?
+I need a module that is able to do millions of calculations every minute. This module is going to be developed
+according to these demands. I'll always be looking out for de-optimization inside the V8 engine.
 
-### Howto to get started
+
+### Howto get started using this module
 ```bash
-git clone [e-mail]:5orenso/geo-lib.git
-cd geo-lib/
-npm install
+$ npm install geo-lib --save
 ```
 
+Then use it in your code.
+
+To find the distance between 2 geo points:
+```javascript
+let geoLib = require('geo-lib');
+let result = geoLib.distance({
+    p1: { lat: 70.3369224, lon: 30.3411273 },
+    p2: { lat: 59.8939528, lon: 10.6450348 }
+});
+// result = {
+//   distance: 1468.28,
+//   unit: 'km',
+//   method: 'haversine'
+// }
+```
+
+To find the distance and speed between 2 geo points:
+```javascript
+let geoLib = require('geo-lib');
+let result = geoLib.distance({
+    p1: { lat: 70.3369224, lon: 30.3411273 },
+    p2: { lat: 59.8939528, lon: 10.6450348 },
+    timeUsed: 86400 * 5
+});
+// result = {
+//   distance: 1468.28,
+//   method: 'haversine',
+//   speedKph: 12.24,
+//   speedMph: 7.61,
+//   speedMpk: '5:54',
+//   timeUsedInSeconds: 432000,
+//   unit: 'km'
+// }
+```
+
+
+----------
+
+### Howto to get started with contributions
+```bash
+$ git clone [e-mail]:5orenso/geo-lib.git
+$ cd geo-lib/
+$ npm install
+```
+
 Start developing. Remember to start watching your files:
 ```bash 
-grunt watch
+$ grunt watch
 ```
@@ -26,3 +72,3 @@
 ```bash
-git clone [e-mail]:5orenso/geo-lib.git
+$ git clone [e-mail]:5orenso/geo-lib.git
 ```
@@ -29,0 +75,0 @@ Do your magic and create a pull request.

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

49720

increased by3.35%

Number of lines in readme file

116

increased by65.71%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes