Skip to content

Commit 4ae06fb

Browse files
authored
Merge pull request #112 from netlify/js-client-docs
Add a mention of our js client to the open-api spec
2 parents 936a5dd + 89cbd54 commit 4ae06fb

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,15 @@ $ go get github.com/netlify/open-api/...
3434

3535
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how this client is developed and generated.
3636

37-
### npm module
37+
### JS Client
38+
39+
[![npm version][npm-js-img]][npm-js] [![downloads][dl-js-img]][dl-js]
40+
41+
We have a fully featured JS/Node.js client that implements some of the same 'porcelain' methods that the go client does in addition to the open-api methods.
42+
43+
See [github.com/netlify/js-client](https://github.com/netlify/js-client) for more details.
44+
45+
#### npm module
3846

3947
[![npm version][npm-img]][npm]
4048

@@ -52,7 +60,7 @@ import spec from '@netlify/open-api' // import the spec object into your project
5260

5361
The module also ships a copy of the original `yml` spec file at `@netlify/open-api/js/dist/swagger.yml`. You can use these with generic swagger/open-api clients:
5462

55-
#### swagger-js
63+
##### swagger-js
5664

5765
Swagger's JS client can dynamically create a client from a spec either from a URL or spec object.
5866

@@ -80,6 +88,10 @@ MIT. See [LICENSE](LICENSE) for more details.
8088
[av-img]: https://ci.appveyor.com/api/projects/status/1g0m72jqhspar6q9/branch/master?svg=true
8189
[npm-img]: https://img.shields.io/npm/v/@netlify/open-api.svg
8290
[npm]: https://npmjs.org/package/@netlify/open-api
91+
[npm-js-img]: https://img.shields.io/npm/v/netlify.svg
92+
[npm-js]: https://npmjs.org/package/netlify
93+
[dl-js-img]: https://img.shields.io/npm/dm/netlify.svg
94+
[dl-js]: https://npmjs.org/package/netlify
8395

8496
[godoc-img]: https://godoc.org/github.com/netlify/open-api/go?status.svg
8597
[godoc]: https://godoc.org/github.com/netlify/open-api/go

0 commit comments

Comments
 (0)