Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 3.13 KB

README.md

File metadata and controls

71 lines (47 loc) · 3.13 KB

kickable

kickable is a microservice built to answer the age old question, "Can I Kick It?"

What is a kickable?

Currently only the word "it" is kickable.

NPM Builds Coverage Vulnerabilities
npm version build status coverage Known Vulnerabilities
downloads build status Coverage Status
Gemnasium Wercker status

Installation

Requires Node.js 6+, iojs is not currently supported

$ npm install kickable --save

Test

$ npm run test

Cover

$ npm run cover

CURRENT COVERAGE REPORT

codecov.io

API

api.kick(it)

Returns true if the string it is determined to be kickable.

parameters:

  • it {String} The value to determine as kickable

returns: {Bool} true if it is determined to be kickable, otherwise false.

What's next?

  • Case Insensitivity
  • Support for configuring kickable items other than it.
  • Return true if the item is known to be a kickable noun, ie. ball, wall, door; otherwise false ( sky, feelings, comments )"

Discuss

Join the chat at https://gitter.im/kickable/Lobby

Questions or comments can also be posted on the kickable Github issues page.

Maintainers

Hector Gray (Twitter: @defstream)

Contribute

Pull Requests welcome. Please make sure all tests pass:

$ npm test

Please submit Github issues for any feature enhancements, bugs or documentation problems.

License

MIT