Skip to content

Commit 11edbe6

Browse files
committed
update geocoding api
1 parent b87e87e commit 11edbe6

File tree

13 files changed

+251
-152
lines changed

13 files changed

+251
-152
lines changed

.github/workflows/npm-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
with:
1414
node-version: 12
1515
registry-url: https://registry.npmjs.org/
16-
- run: yarn install
16+
- run: npm install
1717
- run: npm publish --access public
1818
env:
1919
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,42 @@
11
# @goongmaps/goong-sdk
2+
23
[![npm](https://img.shields.io/npm/v/@goongmaps/goong-sdk.svg)](https://www.npmjs.com/package/@goongmaps/goong-sdk)
34

4-
A JS SDK for working with [Goong REST APIs](https://docs.goong.io/rest/).
5+
A Javascript SDK for working with [Goong REST APIs](https://docs.goong.io/rest/).
6+
7+
- [Directions API](https://docs.goong.io/rest/directions/)
8+
- [Distance Matrix API](https://docs.goong.io/rest/distance_matrix/)
9+
- [Geocoding API](https://docs.goong.io/rest/geocode/)
10+
- [Place API](https://docs.goong.io/rest/place/)
11+
- [Static Map API](https://docs.goong.io/rest/staticmap/)
512

6-
- [Directions API](https://docs.goong.io/rest/direction/)
7-
- [Distance Matrix API](https://docs.goong.io/rest/distance_matrix/)
8-
- [Geocoding API](https://docs.goong.io/rest/geocode/)
9-
- [Place API](https://docs.goong.io/rest/place/)
10-
- [Static Map API](https://docs.goong.io/rest/staticmap/)
11-
1213
Works in Node, the browser, and React Native.
1314

1415
## Table of contents
1516

1617
- [Installation](#installation)
18+
- [Npm](#npm)
19+
- [Yarn](#yarn)
1720
- [Usage](#usage)
1821
- [Creating clients](#creating-clients)
1922
- [Creating and sending requests](#creating-and-sending-requests)
2023
- [Services](#services)
2124
- [Pre-bundled files on unpkg.com](#pre-bundled-files-on-unpkgcom)
2225

2326
## Installation
27+
2428
### Npm
29+
2530
```
2631
npm install @goongmaps/goong-sdk
2732
```
33+
2834
### Yarn
35+
2936
```
3037
yarn add @gongmaps/goong-sdk
3138
```
39+
3240
**If you are supporting older browsers, you will need a Promise polyfill.**
3341
[es6-promise](https://github.com/stefanpenner/es6-promise) is a good one, if you're uncertain.
3442

@@ -45,7 +53,7 @@ There are 3 basic steps to getting an API response:
4553

4654
### Creating clients
4755

48-
To **create a service client**, import the service's factory function from `'@goongmaps/goong-sdk/services/{service}'` and provide it with your access token.
56+
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/).
4957

5058
The service client exposes methods that create requests.
5159

@@ -109,15 +117,3 @@ Here's how you might use it.
109117
.then(..);
110118
</script>
111119
```
112-
113-
[`got`]: https://github.com/sindresorhus/got
114-
115-
[`http`]: https://nodejs.org/api/http.html
116-
117-
[`xmlhttprequest`]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
118-
119-
[`gapirequest`]: #gapirequest
120-
121-
[`gapiresponse`]: #gapiresponse
122-
123-
[`gapierror`]: #gapierror

config/service-doc.yml

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,4 @@ toc:
33
- Geocoding
44
- Autocomplete
55
- Directions
6-
- DistanceMatrix
7-
# - name: Data structures
8-
# description: |
9-
# Data structures used in service method configuration.
10-
# children:
11-
# - DirectionsWaypoint
12-
# - MapMatchingPoint
13-
# - MatrixPoint
14-
# - OptimizationWaypoint
15-
# - SimpleMarkerOverlay
16-
# - CustomMarkerOverlay
17-
# - PathOverlay
18-
# - GeoJsonOverlay
19-
# - UploadableFile
20-
# - Coordinates
21-
# - BoundingBox
6+
- DistanceMatrix

0 commit comments

Comments
 (0)