Skip to content

Commit

Permalink
Add installation and brief example of usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick White committed Jan 19, 2013
1 parent 2cddb30 commit ee49b60
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions 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.