shipit - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

		{
		"name": "shipit",
		"version": "0.0.3",
		"version": "0.0.4",
		"description": "This module allows you to connect to many shipping carriers like UPS and FedEx and download tracking data for your packages in a common schema",
		@@ -19,5 +19,6 @@ "main": "lib/main.js",
		"devDependencies": {
		"chai": "1.9.0",
		"bondjs": "~1.0.0",
		"chai": "~1.9.0",
		"grunt-mocha-test": "~0.6.3",
		"mocha": "1.17.1"
		"mocha": "~1.17.1"
		},
		@@ -24,0 +25,0 @@ "scripts": {

README.md

		@@ -0,1 +1,8 @@
		## What is this?
		`shipit` is a node module that allows you to retrieve data from shipping carriers like UPS and FedEx in a common format. It interfaces with tracking APIs when available, and falls back to screen scraping. For carriers that expose tracking APIs, user is expected to acquire and provide credentials like license numbers, meter numbers, user IDs and passwords.

		### Carriers supported
		* UPS
		* FedEx

		## Usage
		@@ -57,1 +64,26 @@

		## Building
		Just use grunt.
		```
		$ grunt
		Running "coffee:compile" (coffee) task

		Running "mochaTest:src" (mochaTest) task
		3 -_-__,------,
		0 -_-__\| /\_/\
		0 -_-_~\|_( ^ .^)
		-_-_ "" ""

		3 passing (11ms)


		Done, without errors.
		```

		## Adding new shipping carriers
		* Extend the common class `ShipperClient`
		* Implement necessary methods
		- `generateRequest(trk, reference)`
		- `requestOptions({trk, reference})`
		- `validateResponse(response, cb)`

New alerts