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

Use the kickable library in your project by adding it to your Cargo.toml file.

shell $ cargo add kickable

```rust use kickable;

fn main() { let kickable = kickable::validate("it"); println!("Can you kick it? {kickable}"); } ```

Download the binary from the releases page and place it in your path, or if you have cargo installed.

bash $ cargo install kickable

Obtain help about the kickable cli.

```shell $ kickable --help kickable is a crate created to answer the age old question... Can I kick it?

Usage: kickable [OPTIONS]

Arguments: The item to check for kick-ability

Options: -c, --config The path to the configuration file [default: kickable.yaml] -h, --help Print help -V, --version Print version

```

An example of the most basic usage of the kickable cli. ```shell $ kickable "it" Yes, yes you can.

```

Below is an example of an optional kickable configuration file.

```yaml

items: - it # English - él # Spanish - el # Spanish - それ # Japanese - il # French

lang: en-US # default language

logging: level: 1 # 1: debug, 2: info, 3: warning, 4: error, 5: critical file: /var/log/kickable # log file path

server: addr: 0.0.0.0 # address to bind to port: 8080 # port number

client: addr: 127.0.0.1 # address to connect to port: 8080 # port number ```

Hector Gray (@defstream)

Pull Requests welcome. Please make sure all tests pass 😀

Kickable by Hector Gray is marked with CC0 1.0 Universal. To view a copy of this license, visit http://creativecommons.org/publicdomain/zero/1.0