<p align="center">
<img src="https://media2.giphy.com/media/p3R62d6L0WYw0/200w.gif">
</p>
[](https://crates.io/crates/kickable)

[](https://dl.circleci.com/status-badge/redirect/gh/defstream/kickable-rs/tree/main)
[](https://coveralls.io/github/defstream/kickable-rs?branch=main)
[](https://readthedocs.org/projects/kickable-rs)
# kickable
**kickable** is a crate created to answer the age old question... "_Can I Kick It?_"
_This package is for showcase purposes only._
**What is a kickable?**
Currently only the word "it" is kickable.
## Library
### Install
Download the binary from the releases page and place it in your path, or if you have cargo installed.
```shell
$ cargo add kickable
```
### Usage
```rust
use kickable;
fn main() {
let kickable = kickable::validate("it");
println!("Can you kick it? {kickable}");
}
```
## CLI
### Install
```bash
$ cargo install kickable
```
### Usage
```shell
$ kickable "it"
Yes, yes you can.
```
## Maintainers
Hector Gray (<a href="https://hectorgray.com">@defstream</a>)
## Contribute
Pull Requests welcome. Please make sure all tests pass 😀
## License
Kickable by <a href="https://twitter.com/defstream">Hector Gray</a> is marked with CC0 1.0 Universal. To view a copy of this license, visit http://creativecommons.org/publicdomain/zero/1.0
[](http://creativecommons.org/publicdomain/zero/1.0kickable)