Skip to content

Commit c0f68a4

Browse files
authored
Update README.md
1 parent 1a83616 commit c0f68a4

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
11
# roc-color
2-
🌈 Library for styling terminal contents with ANSI, 256 bit color and Truecolor
2+
🌈 Roc package for styling terminal contents with ANSI, 256 bit color and Truecolor
3+
4+
The interface of this library is heavily influenced by the Haskell package [colourista](https://github.com/kowainik/colourista).
5+
6+
## Usage
7+
8+
The main function to interact with is `formatWith` which accepts a list of attributes and a fore- and background color to format a text with. Check the examples to get a feel for the library!
9+
10+
## Documentation
11+
12+
A more detailed documentation of the exposed functions can be found at: https://phagenlocher.github.io/roc-color/

0 commit comments

Comments
 (0)