diff --git a/Cargo.lock b/Cargo.lock index f1e2cbe..d383064 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -191,7 +191,7 @@ dependencies = [ [[package]] name = "omekasy" -version = "0.1.0" +version = "0.2.0" dependencies = [ "clap", "crossterm", diff --git a/Cargo.toml b/Cargo.toml index 8789b78..dcd7fe2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "omekasy" -version = "0.1.0" +version = "0.2.0" authors = ["ikanago "] -description = "Decorate latin alphabet and numbers in your input with various font; special characters in Unicode" +description = "Decorate alphanumeric characters in your input with various font; special characters in Unicode" license = "MIT" readme = "README.md" homepage = "https://github.com/ikanago/omekasy" diff --git a/README.md b/README.md index 2420cb5..319cd52 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,42 @@ [![CI](https://github.com/ikanago/rusty_boilerplate/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ikanago/rusty_boilerplate/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![](https://img.shields.io/crates/v/omekasy.svg)](https://crates.io/crates/omekasy) +`omekasy` is a command line application that converts alphanumeric characters in your input to various styles defined in Unicode. +`omekasy` means "dress up" in Japanese. + +## Installation +You can download binaries from [Releases](https://github.com/ikanago/omekasy/releases). + +Or you can build it by yourself. +```bash +cargo install omekasy +``` + +## Usage +Just run without any options or arguments, a prompt will be shown up. +You can select the style while watching the result. +```bash +omekasy +``` + +To convert to a specific font instantly, give the font name and input. +```bash +omekasy --font bold-italic "My new gear..." +``` +Characters other than latin alphabets and numbers in your input remain untouched. + +Available font for now: +- bold +- italic +- bold-italic +- sans +- sans-bold +- sans-italic +- sans-bold +- italic +- script +- bold-script +- monospace +- blackboard