From aea25389f7423f5fa4c7016d72dda6809f4a09b8 Mon Sep 17 00:00:00 2001 From: Bret Comnes Date: Tue, 25 Sep 2018 17:36:13 -0700 Subject: [PATCH 1/2] Add a mention of our js client to the open-api spec --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3dab2371..712c2475 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,15 @@ $ go get github.com/netlify/open-api/... See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how this client is developed and generated. -### npm module +### JS Client + +[![npm version][npm-js-img]][npm-js] [![downloads][dl-img]][dl] + +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. + +See [github.com/netlify/js-client](https://github.com/netlify/js-client) for more details. + +#### npm module [![npm version][npm-img]][npm] @@ -52,7 +60,7 @@ import spec from '@netlify/open-api' // import the spec object into your project 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: -#### swagger-js +##### swagger-js Swagger's JS client can dynamically create a client from a spec either from a URL or spec object. @@ -80,6 +88,10 @@ MIT. See [LICENSE](LICENSE) for more details. [av-img]: https://ci.appveyor.com/api/projects/status/1g0m72jqhspar6q9/branch/master?svg=true [npm-img]: https://img.shields.io/npm/v/@netlify/open-api.svg [npm]: https://npmjs.org/package/@netlify/open-api +[npm-js-img]: https://img.shields.io/npm/v/netlify.svg +[npm-js]: https://npmjs.org/package/netlify +[dl-js-img]: https://img.shields.io/npm/dm/netlify.svg +[dl-js]: https://npmjs.org/package/netlify [godoc-img]: https://godoc.org/github.com/netlify/open-api/go?status.svg [godoc]: https://godoc.org/github.com/netlify/open-api/go From 89cbd54129c2025be178afa98fd15e38355ea09c Mon Sep 17 00:00:00 2001 From: Bret Comnes Date: Tue, 25 Sep 2018 17:37:37 -0700 Subject: [PATCH 2/2] Fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 712c2475..d354660c 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how this client is develop ### JS Client -[![npm version][npm-js-img]][npm-js] [![downloads][dl-img]][dl] +[![npm version][npm-js-img]][npm-js] [![downloads][dl-js-img]][dl-js] 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.