shipit - npm Package Compare versions

Comparing version 0.7.2 to 0.7.3

package.json

 {
   "name": "shipit",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "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",
@@ -5,0 +5,0 @@ "main": "lib/main.js",

README.md

 ## What is this?
 ### Shipping APIs Adapter
 `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.
+
 ### Carrier Guessing
 Really, why do users have to know that a tracking number was provided by a particular carrier. That step is just totally unnecessary, given that we can guess the carrier from the tracking number in 90% of the cases. `shipit` provides a convenience function for this.
 
+### Try it
+There's a [Heroku](http://www.heroku.com) hobby app that allows you to see `shipit` in action.  For example, try this:
+```
+http://shipit-api.herokuapp.com/api/carriers/ups/1ZV5E9420444964064
+```
+And replace `ups` with a [canonical name](https://github.com/sailrish/shipit/blob/master/src/guessCarrier.coffee#L91-L121) for any of the supported carriers, and provide a valid tracking number for that carrier.
+
+_*Note*: `shipit-api` Heroku app is not meant for production use, and there are no guarantees included here, regarding it's availability, or up-time. It is only meant as a preview for the `shipit` node module._
+
 ### Carriers supported
@@ -183,3 +193,3 @@ * UPS
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files, but excluding the `shipit-api` Heroku app mentioned above (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
@@ -186,0 +196,0 @@ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

No alert changes

Improved metrics

Total package byte prevSize

111643

increased by0.62%

Number of lines in readme file

201

increased by5.24%

No dependency changes