diff --git a/README.md b/README.md index 35a4147..adb5ac3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ # smartinteract -interact with terminal users +smart cli interaction ## Availabililty -[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartinteract) -[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartinteract) -[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartinteract) -[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartinteract/) +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartinteract) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartinteract) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartinteract) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartinteract/) ## Status for master -[![build status](https://gitlab.com/pushrocks/smartinteract/badges/master/build.svg)](https://gitlab.com/pushrocks/smartinteract/commits/master) -[![coverage report](https://gitlab.com/pushrocks/smartinteract/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartinteract/commits/master) +[![build status](https://GitLab.com/pushrocks/smartinteract/badges/master/build.svg)](https://GitLab.com/pushrocks/smartinteract/commits/master) +[![coverage report](https://GitLab.com/pushrocks/smartinteract/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartinteract/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/smartinteract.svg)](https://www.npmjs.com/package/smartinteract) [![Dependency Status](https://david-dm.org/pushrocks/smartinteract.svg)](https://david-dm.org/pushrocks/smartinteract) [![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartinteract/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartinteract/master/dependencies/npm) [![bitHound Code](https://www.bithound.io/github/pushrocks/smartinteract/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartinteract) @@ -18,39 +19,11 @@ interact with terminal users [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) ## Usage -We recommend the use of TypeScript for best in class intellesense +Use TypeScript for best in class instellisense. -```javascript -import { SmartInteract } from 'smartinteract' +For further information read the linked docs at the top of this README. -let myInteract = new SmartInteract([{ // note: its an array. You can specify multiple questions - name: 'question1', - type: 'input', - message: 'Who are you?', - default: 'Somebody', - validate: (inputString) => { return true } // implement your own validation -}]) -myInteract.addQuestions([ ... ]) // add more questions -myInteract.runQueue() - .then(answerBucket => { // the bucket has all the answers of the completed queue - let answerQuestion1 = answerBucket.getAnswerFor('question1') - // do something with the answers - }) +> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) -// alternatively use .askQuestion() for more direct control -myInteract.askQuestion{ // note: its an array. You can specify multiple questions - name: 'question2', - type: 'confirm', - message: 'Do you speak English?', - default: true, - validate: (inputString) => { return true } // implement your own validation -}().then(answerObject => { - // answerObject looks like { name: 'question2', value: true } -}) -``` - -### Environment -In some environments like CI there is no user input to be expected. -smartinteract will always directyl create an answer from the default value - -[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks) +[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks) diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..4c0fb7e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,60 @@ +# smartinteract +smart cli interaction + +## Availabililty +[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartinteract) +[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartinteract) +[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartinteract) +[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartinteract/) + +## Status for master +[![build status](https://GitLab.com/pushrocks/smartinteract/badges/master/build.svg)](https://GitLab.com/pushrocks/smartinteract/commits/master) +[![coverage report](https://GitLab.com/pushrocks/smartinteract/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartinteract/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/smartinteract.svg)](https://www.npmjs.com/package/smartinteract) +[![Dependency Status](https://david-dm.org/pushrocks/smartinteract.svg)](https://david-dm.org/pushrocks/smartinteract) +[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartinteract/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartinteract/master/dependencies/npm) +[![bitHound Code](https://www.bithound.io/github/pushrocks/smartinteract/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartinteract) +[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) +[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) +[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) + +## Usage +Use TypeScript for best in class instellisense. + + +```javascript +import { SmartInteract } from 'smartinteract' + +let myInteract = new SmartInteract([{ // note: its an array. You can specify multiple questions + name: 'question1', + type: 'input', + message: 'Who are you?', + default: 'Somebody', + validate: (inputString) => { return true } // implement your own validation +}]) +myInteract.addQuestions([ ... ]) // add more questions +myInteract.runQueue() + .then(answerBucket => { // the bucket has all the answers of the completed queue + let answerQuestion1 = answerBucket.getAnswerFor('question1') + // do something with the answers + }) + +// alternatively use .askQuestion() for more direct control +myInteract.askQuestion{ // note: its an array. You can specify multiple questions + name: 'question2', + type: 'confirm', + message: 'Do you speak English?', + default: true, + validate: (inputString) => { return true } // implement your own validation +}().then(answerObject => { + // answerObject looks like { name: 'question2', value: true } +}) +``` + + +For further information read the linked docs at the top of this README. + +> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) + +[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)