From 7eb9cda1e0aa7f85f2bce5e1ed369b3c4a75b4c7 Mon Sep 17 00:00:00 2001 From: Kay Schecker <30752021+kay-schecker@users.noreply.github.com> Date: Sat, 3 Nov 2018 15:06:11 +0100 Subject: [PATCH] Added hint for npm package wrapper to README (#1350) * Added hint for npm package wrapper to README * Added manual how to use and install NPM package globally --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e35176c7eab..0661468210a 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se - [1.4 - Build Projects](#14---build-projects) - [1.5 - Homebrew](#15---homebrew) - [1.6 - Docker](#16---docker) + - [1.7 - NPM](#17---npm) - [2 - Getting Started](#2---getting-started) - [3 - Usage](#3---usage) - [3.1 - Customization](#31---customization) @@ -346,6 +347,24 @@ cd /vagrant ./run-in-docker.sh mvn package ``` +### [1.7 - NPM](#table-of-contents) + +There is also an [NPM package wrapper](https://github.com/HarmoWatch/openapi-generator-cli), available. +Please see the [docs](https://github.com/HarmoWatch/openapi-generator-cli) there for more information. + +Install it globally to get the CLI available on the command line: + +```sh +npm install @harmowatch/openapi-generator-cli -g +openapi-generator version +``` + +Or you install it as dev-dependency like this: + +```sh +npm install @harmowatch/openapi-generator-cli -D +``` + ## [2 - Getting Started](#table-of-contents) To generate a PHP client for [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml), please run the following