From e3f15ee341bfbcee46ab4c8ac9bba08b0da35162 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Tue, 1 Jun 2021 13:17:03 +0100 Subject: [PATCH] chore: remove not needed readme file --- .../src/generated/README.md | 45 ------------------- 1 file changed, 45 deletions(-) delete mode 100644 packages/kafka-management-sdk/src/generated/README.md diff --git a/packages/kafka-management-sdk/src/generated/README.md b/packages/kafka-management-sdk/src/generated/README.md deleted file mode 100644 index 7e5dfddd..00000000 --- a/packages/kafka-management-sdk/src/generated/README.md +++ /dev/null @@ -1,45 +0,0 @@ -## @rhoas/kafka-management-sdk@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run ```npm publish``` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install @rhoas/kafka-management-sdk@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save