Skip to content

Commit

Permalink
Stylize README.
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioBenitez committed Mar 6, 2024
1 parent 3e01eae commit 813b936
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
1 change: 1 addition & 0 deletions .github/yansi-example.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/yansi-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# `yansi`
<div align="left">
<img src="https://raw.githubusercontent.com/SergioBenitez/yansi/master/.github/yansi-logo.png"
align="center" alt="yansi logo" width="64" height="64">
<span>&nbsp;<b>Yansi</b></span>
<p>A dead simple ANSI terminal color painting library.</p>

[![Build Status](https://github.com/SergioBenitez/yansi/workflows/CI/badge.svg)](https://github.com/SergioBenitez/yansi/actions)
[![Current Crates.io Version](https://img.shields.io/crates/v/yansi.svg)](https://crates.io/crates/yansi)
[![Documentation](https://docs.rs/yansi/badge.svg)](https://docs.rs/yansi)
[![Build Status](https://github.com/SergioBenitez/yansi/workflows/CI/badge.svg)](https://github.com/SergioBenitez/yansi/actions)
[![Current Crates.io Version](https://img.shields.io/crates/v/yansi.svg)](https://crates.io/crates/yansi)
[![Documentation](https://docs.rs/yansi/badge.svg)](https://docs.rs/yansi)
</div>

A dead simple ANSI terminal color painting library.
## Usage

In your `Cargo.toml`:

```toml
[dependencies]
yansi = "1.0"
```

In your source code:

```rust
use yansi::Paint;
Expand All @@ -15,10 +29,9 @@ println!("Testing, {}, {}, {}!",
"STOP".white().on_red().bright().underline().bold());
```

`>` Testing,
<b>Ready</b>,
<span style="color: yellow; background: black;"><i><b>Set</b></i></span>,
<span style="color: white; background: red;"><u><b>STOP</b></u></span>!
![> Testing, Ready, Set, STOP!](https://raw.githubusercontent.com/SergioBenitez/yansi/master/.github/yansi-example.svg)

[See the rustdocs](https://docs.rs/yansi) for complete usage details.

## Features

Expand Down

0 comments on commit 813b936

Please sign in to comment.