pealn 0.3.0

Intuitive way to print colored and styled text to console ,use predefined and RGB colors , use text styles , using ANSI #terminal #console #colors #text #print #pealn #win #windows #ansi
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# Pealn


<p align="center">
  <img src="res/pealn_icon.png" alt="Pealn Icon" width="200" />
</p>

<p align="center">
  <a href="https://crates.io/crates/pealn">
    <img src="https://img.shields.io/crates/d/pealn.svg" alt="Crates.io downloads">
  </a>
  <a href="https://crates.io/crates/pealn">
    <img src="https://img.shields.io/crates/v/pealn.svg" alt="Crates.io version">
  </a>
  <a href="https://crates.io/crates/pealn">
    <img src="https://img.shields.io/crates/l/pealn.svg" alt="Crates.io license">
  </a>
</p>


**Pealn** is a Rust library for **printing coloured text** to make your CLI app  beautiful as a Peacock

## Features

- **Compile time** format pealn codes during compile time i,e \[red](name) converted to \x1b\[38;2;255;0;0m name \x1b[0m during compile time
- **Easy to use** Apply modification inside string
- **Pre defined Colors** Common colors  are already defined
- **Text Styles** Add Styles like , bold , italic , underline and more
- **Use RGB colors** Apply colors using RGB value

## Installation


Add Pealn to your Cargo.toml:

```toml
[dependencies]
pealn = "0.3"
```

Add Pealn using Cargo CLI:
```
cargo add Pealn
```
Available macros to print colored and styled text

```rust
pea!("hello world"); // to print on same line
pealn!("hello world"); // to print on next line
```


print new line  with colored and styles
## Format


```rust
[foreground,background,styles....](text) 
```

### Available Colors 

 red, green, blue, yellow, cyan,purple , magenta, black, white
  
### Available Styles 

 bold, dim, italic, underline, blink, reverse, hidden, strikethrough

### *Note:Some styles are not supported on every console , like blink,reverse and dim 
## Examples
 
 To print text with foreground
 ```rust
 use pealn::{pealn};
 pealn!("[yellow](Hello) [green](World)!");
 let name  = "Subham Shaw";
 pealn!("[yellow,bold](Name) : [bold,hidden]({}) " , name );
 ```

 you can use RGB color 

```rust
 use pealn::{pealn};
 pealn!("[(25,45,78)](Hello) [(34,67,78)](World)!");
 ```

 To print text with foreground and background
 ```rust
 use pealn::{pealn};
 pealn!("[yellow,white](Hello) [green,white](World)!");
 ```
 
 To print text with styles
 ```rust
 use pealn::{pealn};
 
 pealn!("[bold,underline](Hello) [italic](World)!");
 ```
 
 To print text with color and styles
 ```rust
 use pealn::{pealn};
 //here order of colors and styles does not matter, 
 //first color will be used as foreground and second as background
 pealn!("[red,green,bold,underline](Hello) [yellow,white,italic](World)!");
 ```
---

*Pealn makes your CLI apps more colorful and expressive!*