Browse files

Created package.json for npm publishing

Updated README
  • Loading branch information...
1 parent 0a7e4c1 commit 5d5eeb7981e362172d8a8a46b9c6a9ac44b9e3f0 @moshen committed Aug 18, 2010
Showing with 35 additions and 8 deletions.
  1. +14 −8 README.md
  2. +21 −0 package.json
View
22 README.md
@@ -6,16 +6,15 @@ This was a quick hack to work with Node.js. Criticism/Suggestions/Patches/PullR
# Status
APIs implemented:
-* Geocoding
-* Directions
-* Elevation
+* [Geocoding](http://code.google.com/apis/maps/documentation/geocoding/)
+* [Directions](http://code.google.com/apis/maps/documentation/directions/)
+* [Elevation](http://code.google.com/apis/maps/documentation/elevation/)
TODO:
-* Places
-* Static Maps
-* Tests for everything
-* create npm package
+* [Places](http://code.google.com/apis/maps/documentation/places/)
+* [Static Maps](http://code.google.com/apis/maps/documentation/staticmaps/)
+* [Tests for everything](./tree/master/test/) (using [vows](http://vowsjs.org/))
# Usage
var gm = require('googlemaps');
@@ -32,5 +31,12 @@ TODO:
Both examples print:
{"status":"OK","results":[{"types":["postal_code"],"formatted_address":"Chicago, IL 60695, USA"...
-Please refer to the code, tests and the [Google Maps API docs](http://code.google.com/apis/maps/documentation/webservices/index.html) for further usage information.
+All the googlemaps functions follow this scheme:
+ function(required, callback, optional)
+
+All callbacks are expected to follow:
+ function(error, results)
+Where the error returned is an Error object.
+
+Please refer to the code, [tests](./tree/master/test/) and the [Google Maps API docs](http://code.google.com/apis/maps/documentation/webservices/index.html) for further usage information.
View
21 package.json
@@ -0,0 +1,21 @@
+{
+ "name": "googlemaps",
+ "version": "0.1.0",
+ "main": "./lib/googlemaps",
+ "description": "A simple way to query the Google Maps API from Node.js",
+ "repositories": [
+ {
+ "type": "git",
+ "url": "http://github.com/moshen/node-googlemaps"
+ }
+ ],
+ "directories": {
+ "tests": "test",
+ "lib": "lib"
+ },
+ "engines": {
+ "node": ">=0.1.104"
+ }
+}
+
+

0 comments on commit 5d5eeb7

Please sign in to comment.