defstream / kickable-rs

Can you kick it?

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

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

$ cargo add kickable

Usage

use kickable;

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

CLI

Install

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

$ cargo install kickable

Usage

Obtain help about the kickable cli.

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

Usage: kickable [OPTIONS] <ITEM>

Arguments:
  <ITEM>  The item to check for kick-ability

Options:
  -c, --config <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.

$ kickable "it"
Yes, yes you can.

Configuration

Below is an example of an optional kickable configuration file.

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

# language preferred for i18n messages
lang: en-US # default language

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

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

# client configuration
client:
  addr: 0.0.0.0 # address to connect to
  port: 8080 # port number

Maintainers

Hector Gray (@defstream)

Contribute

Pull Requests welcome. Please make sure all tests pass 😀

License

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