update geocoding api

goong-io · Jul 13, 2021 · 11edbe6 · 11edbe6
1 parent b87e87e
commit 11edbe6
Show file tree

Hide file tree

Showing 13 changed files with 251 additions and 152 deletions.
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -13,7 +13,7 @@ jobs:
         with:
           node-version: 12
           registry-url: https://registry.npmjs.org/
-      - run: yarn install
+      - run: npm install
       - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
diff --git a/README.md b/README.md
@@ -1,34 +1,42 @@
 # @goongmaps/goong-sdk
+
 [![npm](https://img.shields.io/npm/v/@goongmaps/goong-sdk.svg)](https://www.npmjs.com/package/@goongmaps/goong-sdk)
 
-A JS SDK for working with [Goong REST APIs](https://docs.goong.io/rest/).
+A Javascript SDK for working with [Goong REST APIs](https://docs.goong.io/rest/).
+
+- [Directions API](https://docs.goong.io/rest/directions/)
+- [Distance Matrix API](https://docs.goong.io/rest/distance_matrix/)
+- [Geocoding API](https://docs.goong.io/rest/geocode/)
+- [Place API](https://docs.goong.io/rest/place/)
+- [Static Map API](https://docs.goong.io/rest/staticmap/)
 
- - [Directions API](https://docs.goong.io/rest/direction/)
- - [Distance Matrix API](https://docs.goong.io/rest/distance_matrix/)
- - [Geocoding API](https://docs.goong.io/rest/geocode/)
- - [Place API](https://docs.goong.io/rest/place/)
- - [Static Map API](https://docs.goong.io/rest/staticmap/)
-
 Works in Node, the browser, and React Native.
 
 ## Table of contents
 
 - [Installation](#installation)
+  - [Npm](#npm)
+  - [Yarn](#yarn)
 - [Usage](#usage)
   - [Creating clients](#creating-clients)
   - [Creating and sending requests](#creating-and-sending-requests)
 - [Services](#services)
 - [Pre-bundled files on unpkg.com](#pre-bundled-files-on-unpkgcom)
 
 ## Installation
+
 ### Npm
+
 ```
 npm install @goongmaps/goong-sdk
 ```
+
 ### Yarn
+
 ```
 yarn add @gongmaps/goong-sdk
 ```
+
 **If you are supporting older browsers, you will need a Promise polyfill.**
 [es6-promise](https://github.com/stefanpenner/es6-promise) is a good one, if you're uncertain.
 
@@ -45,7 +53,7 @@ There are 3 basic steps to getting an API response:
 
 ### Creating clients
 
-To **create a service client**, import the service's factory function from `'@goongmaps/goong-sdk/services/{service}'` and provide it with your access token.
+To **create a service client**, import the service's factory function from `'@goongmaps/goong-sdk/services/{service}'` and provide it with your [access token](https://docs.goong.io/rest/api-key/).
 
 The service client exposes methods that create requests.
 
@@ -109,15 +117,3 @@ Here's how you might use it.
     .then(..);
 </script>
 ```
-
-[`got`]: https://github.com/sindresorhus/got
-
-[`http`]: https://nodejs.org/api/http.html
-
-[`xmlhttprequest`]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
-
-[`gapirequest`]: #gapirequest
-
-[`gapiresponse`]: #gapiresponse
-
-[`gapierror`]: #gapierror
diff --git a/config/service-doc.yml b/config/service-doc.yml
@@ -3,19 +3,4 @@ toc:
   - Geocoding
   - Autocomplete
   - Directions  
-  - DistanceMatrix  
-  # - name: Data structures
-  #   description: |
-  #     Data structures used in service method configuration.
-  #   children:
-  #     - DirectionsWaypoint
-  #     - MapMatchingPoint
-  #     - MatrixPoint
-  #     - OptimizationWaypoint
-  #     - SimpleMarkerOverlay
-  #     - CustomMarkerOverlay
-  #     - PathOverlay
-  #     - GeoJsonOverlay
-  #     - UploadableFile
-  #     - Coordinates
-  #     - BoundingBox
+  - DistanceMatrix