sreality-client - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

deployInfo.txt

@@ -1,5 +0,5 @@
-commit 504211d85c93efc1764fe53a988b01010f433614
+commit 647ab16c5d796d0a5b85a0947b9ab5f1bfc7dc98
 Author: Carranza, Milton <[e-mail]>
-Date:   Tue Apr 2 00:23:14 2019 +0200
+Date:   Tue Apr 2 10:58:57 2019 +0200
 
-    disclaimer
+    0.0.2

package.json

 {
   "name": "sreality-client",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "API Client for sreality.cz",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -7,20 +7,53 @@ # Sreality.cz
 
+### House Collection
+
 Parameters: 
 ```
-page = 1, pageSize = 50, regionType = 'municipality', regionId = 3468
+page = 1, pageSize = 5, regionType = 'municipality', regionId = 3468
 ```
 
 Example: 
+
 ```
-const { fetchHouses, fetchFlats, fetchParcels } = require('sreality-api-client');
-const houses = await fetchHouses(1, 50, 'municipality', 3468);
-const flats = await fetchFlats(1, 50, 'municipality', 3468);
-const parcels = await fetchParcels(1, 50, 'municipality', 3468);
+const { fetchHouses } = require('sreality-client');
 
-console.log(houses);
-console.log(flats);
-console.log(parcels);
+fetchHouses(1, 5, 'municipality', 3468).then((data) => {
+    console.log('My Houses...', data);
+});
+```
 
+### Flat Collection
+
+Parameters: 
 ```
+page = 1, pageSize = 5, regionType = 'municipality', regionId = 3468
+```
 
+Example: 
+
+```
+const { fetchFlats } = require('sreality-client');
+
+fetchFlats(1, 5, 'municipality', 3468).then((data) => {
+    console.log('My Flats...', data);
+});
+```
+
+### Parcels Collection
+
+Parameters: 
+```
+page = 1, pageSize = 5, regionType = 'municipality', regionId = 3468
+```
+
+Example: 
+
+```
+const { fetchParcels } = require('sreality-client');
+
+fetchParcels(1, 5, 'municipality', 3468).then((data) => {
+    console.log('My Parcels...', data);
+});
+```
+
 ## Build
@@ -27,0 +60,0 @@

No alert changes

Improved metrics

Total package byte prevSize

8732

increased by4.89%

Number of lines in readme file

92

increased by55.93%

No dependency changes