Permalink
Browse files

Add installation and brief example of usage

  • Loading branch information...
1 parent 2cddb30 commit ee49b60e6eb07b03dc120c207ec91dbd76cd4040 @nwhite89 committed Jan 19, 2013
Showing with 16 additions and 0 deletions.
  1. +16 −0 README.md
View
16 README.md
@@ -1,2 +1,18 @@
# GeoDistance.js
### A Node.js module which takes 2 Lat+Lng (Geolocation) points and returns the distance between the two points in Meters
+
+Installation
+-----
+npm install geo-distance-js
+
+----
+Function
+getDistance(toLat, toLng, fromLat, fromLng);
+
+Add the module as a variable in your .js file
+
+var dist = require('geo-distance-js');
+
+Run the function with
+
+dist.getDistance(toLat, toLng, fromLat, fromLng);

0 comments on commit ee49b60

Please sign in to comment.