https://github.com/defstream/kickable
Kickable is a service built to answer the age old question of "Can I Kick It?"
https://github.com/defstream/kickable
Last synced: about 1 year ago
JSON representation
Kickable is a service built to answer the age old question of "Can I Kick It?"
- Host: GitHub
- URL: https://github.com/defstream/kickable
- Owner: defstream
- License: mit
- Created: 2017-04-06T08:10:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T00:45:24.000Z (over 3 years ago)
- Last Synced: 2025-04-01T19:08:05.759Z (about 1 year ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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 |
| :------------- | :------------- | :------------- | :------------- |
| 
| 
| 
| 
|
| 
| 
| 
|
| 
| | |
# Installation
**Requires Node.js 6+, iojs is not currently supported**
```shell
$ npm install kickable --save
```
#### Test
```shell
$ npm run test
```
#### Cover
```shell
$ npm run cover
```
**CURRENT COVERAGE REPORT**
# 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
[](https://gitter.im/kickable/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
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:
```shell
$ npm test
```
Please submit Github issues for any feature enhancements, bugs or documentation problems.
### License
MIT