Skip to content

Commit

Permalink
Added header
Browse files Browse the repository at this point in the history
  • Loading branch information
britzl committed Mar 1, 2018
1 parent fb01c7e commit bbc5737
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,14 @@ The following named colors are supported:
# Usage
The RichText library will create gui text nodes representing the markup in the text passed to the library. It will search for tags and split the entire text into words, where each word contains additional meta-data that is used to create and configure text nodes. This means that the library will create as many text nodes as there are words in the text.

## Basic usage
## Basic example
A simple example with some color and linebreaks:

richtext.create("Single line text with a dash of <color=red>color</color>\nBy default left aligned.", "Roboto-Regular")

![](docs/basic.png)

## Advanced example
A more complex example with different fonts, colors, inline images and automatic linebreaks:

local settings = {
Expand Down

0 comments on commit bbc5737

Please sign in to comment.