Merge c580f43 into f0c2205

osmlab · Mar 3, 2018 · 97a50b3 · 97a50b3
2 parents f0c2205 + c580f43
commit 97a50b3
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.3.1
+
+* Add an explanation about the API options in the README.
+
 ## 1.3.0
 
 * Transfer the repository to the osmlab organization.

diff --git a/README.md b/README.md
@@ -26,6 +26,22 @@ osmose.fetchErrors({ item: 8120 })
   .then(result => console.log(result));
 ```
 
+In the previous example, the `item` option is one of the many Osmose options available and listed here:
+https://wiki.openstreetmap.org/wiki/Osmose/api/0.2#Settings
+
+For now, the value of the options have the same shape as the real API options. It will be more JS friendly in the future.
+
+So for example, if you want to limit the returned results to a specific location, you can add the `bbox` option like that:
+
+``` javascript
+import OsmoseRequest from 'osmose-request';
+
+const osmose = new OsmoseRequest();
+
+osmose.fetchErrors({ item: 8120, bbox: '1.123,-0.124,2.767,0.243' })
+  .then(result => console.log(result));
+```
+
 
 ### Options
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "osmose-request",
   "description": "Request the Osmose API from Javascript, with promises :)",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "homepage": "https://github.com/osmlab/osmose-request/",
   "repository": "https://github.com/osmlab/osmose-request/",
   "bugs": "https://github.com/osmlab/osmose-request/issues",