Skip to content
This repository was archived by the owner on Jan 13, 2024. It is now read-only.

Commit b43cce4

Browse files
author
DirectiveAthena
committed
Update Readme
1 parent 65f97e5 commit b43cce4

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,38 @@ A *No Dependency* python package for displaying the full spectrum of RGB colors
1010
- *Nested* and *Inline* options to print StyleNest and Color makeup to the Console
1111
- 140 predefined extended HTML colors
1212
- By using the `RGB` object, you have access to print any RGB color to the console you desire
13-
13+
14+
---
15+
## Quick Examples
16+
Inline styling:
17+
```python
18+
from AthenaColor import Fore, Style
19+
print(
20+
f"""
21+
{Style.Italic}{Fore.SlateGray}AthenaColor Example:{Style.NoForeground}
22+
{Fore.Red}This is an of {Style.Bold}EXAMPLE{Style.NoBold} nested styling{Style.NoForeground}
23+
{Fore.SlateGray}As you can see, the color needs to be manually returned here{Style.NoForeground}{Style.NoItalic}
24+
"""
25+
)
26+
```
27+
Nested Styling:
28+
```python
29+
from AthenaColor import ForeNest, StyleNest
30+
31+
print(
32+
StyleNest.Italic(ForeNest.SlateGray(
33+
"AthenaColor Example:",
34+
ForeNest.Red(
35+
"This is an",
36+
StyleNest.Bold("EXAMPLE"),
37+
"of nested styling"
38+
),
39+
"As you can see, the correct color returns here by itself",
40+
sep="\n"
41+
))
42+
)
43+
```
44+
1445
---
1546
## Documentation
1647
Full documentation can be found at:

src/AthenaColor/__main__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
# Custom Library
88

99
# Custom Packages
10-
import AthenaColor
1110

1211
# ----------------------------------------------------------------------------------------------------------------------
1312
# - All -

0 commit comments

Comments
 (0)