citibike - npm Package Compare versions

Comparing version 2.1.2 to 2.1.3

examples/bikes.js

 /**
- *  Get a list of available stations and bikes.
- *     
-    Example Response:
-    {
-      ok: true,
-      meta: [ ],
-      results: [
-        {
-          id: 72,
-          status: "Active",
-          latitude: 40.76727216,
-          longitude: -73.99392888,
-          label: "W 52 St & 11 Av",
-          stationAddress: "",
-          availableBikes: 15,
-          availableDocks: 22,
-          nearbyStations: [
-            {
-            id: 480,
-            distance: 0.17780736685282
-            },
-            {
-            id: 508,
-            distance: 0.30285853404336
-            },
-            {
-            id: 495,
-            distance: 0.3196273377671
-            },
-            {
-            id: 422,
-            distance: 0.3446534955824
-            },
-            {
-            id: 449,
-            distance: 0.36516621792546
-            }
-          ]
-        },
-        
-        ... etc ...
-
-      ]
-      activeStations: 304,
-      totalStations: 327,
-      lastUpdate: 1370713417
-    }
- *  
+ *  Retrieves JSON data for stations, helmets, and bikes.
  */
@@ -51,0 +4,0 @@

package.json

@@ -12,3 +12,3 @@ {
   ],
-  "version": "2.1.2",
+  "version": "2.1.3",
   "author": "Kevin Coughlin <[e-mail]>",
@@ -15,0 +15,0 @@ "contributors": [

README.md

@@ -51,2 +51,44 @@ # Citibike [![Build Status](https://travis-ci.org/KevinTCoughlin/citibike.png)](https://travis-ci.org/KevinTCoughlin/citibike)
 
+  * **Sample JSON Response**
+
+        {
+          "ok": true,
+          "meta": [],
+          "results": [
+              {
+                  "id": 72,
+                  "status": "Active",
+                  "latitude": 40.76727216,
+                  "longitude": -73.99392888,
+                  "label": "W 52 St & 11 Ave",
+                  "stationAddress": "",
+                  "availableBikes": 12,
+                  "availableDocks": 22,
+                  "nearbyStations": [
+                      {
+                          "id": 480,
+                          "distance": 0.17780736685282
+                      },
+                      {
+                          "id": 513,
+                          "distance": 0.28502152791732
+                      },
+                      {
+                          "id": 508,
+                          "distance": 0.30285853404336
+                      },
+                      {
+                          "id": 495,
+                          "distance": 0.3196273377671
+                      },
+                      {
+                          "id": 530,
+                          "distance": 0.3430221582592
+                      }
+                  ]
+              },
+              ... more stations ...
+          ],
+        "activeStations":308,"totalStations":313,"lastUpdate":1371908767}
+
   * **Branches - .getBranches( params, callback )**
@@ -58,2 +100,11 @@
         
+  * **Sample Branches JSON Response**
+  
+        {"ok": true, "meta": [], "results":[
+          { "id":1, "latitude":40.7086647301912, "longitude":-74.0108752995729, "label":"120 Broadway" },
+          { "id":2, "latitude":40.7533264160156, "longitude":-73.9794006347656, "label":"330 Madison Ave" },
+          { "id":3, "latitude":40.7042541503906, "longitude":-74.0070037841797, "label":"111 Wall St" },
+          ... more branches ...
+        ],"lastUpdate": 1367853735}
+        
   * **Helmets - .getHelmets( params, callback )**
@@ -64,2 +115,12 @@
         });
+  
+  * **Sample Helmets JSON Response**
+  
+        {"ok": true, "meta": [], "results":[
+          { "id":5002, "address":"571 Courtlandt Av", "latitude":40.8170769363642, "longitude":-73.9193703979254, "label":"Neighborhood Cycle, Inc." },
+          { "id":5008, "address":"178 Graham Av", "latitude":40.7078323364258, "longitude":-73.9429473876953, "label":"Graham Bicycle Discount Center" },
+          { "id":5000, "address":"4055 White Plains Rd", "latitude":40.8901315927505, "longitude":-73.8593445718288, "label":"Arrow Cycle, Inc" },
+          { "id":5001, "address":"33 E 170th St", "latitude":40.8400574326515, "longitude":-73.9171025902033, "label":"Crosstown Bicycles" },
+          ... more helmet locations ...
+        ],"lastUpdate": 1367853737}
 
@@ -66,0 +127,0 @@ ## Testing

No alert changes

Improved metrics

Total package byte prevSize

36435

increased by4.7%

Number of lines in readme file

156

increased by64.21%

Worsened metrics

Lines of code

284

decreased by-13.68%

No dependency changes