Skip to content

Commit

Permalink
Updated README.rst with color format syntax escaping rules
Browse files Browse the repository at this point in the history
  • Loading branch information
MisanthropicBit committed Dec 12, 2019
1 parent f24aadf commit 0ff6072
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ of returning a string:
>>> colorise.highlight("Highlight this text!", fg='blue', indices=[4, 17, 3, 5, 10])
If you have a ``<`` or ``>`` in your string, you can escape it with a backslash ``\``. The backslash
is automatically removed. Colons ``:`` are ignored if they appear in text.

.. code::
>>> colorise.fprint("<fg=darkpurple:Some : \> silly \< string>")
Implementation notes
--------------------
On Linux and Unix there are no 'dark' themed backgrounds, so calling
Expand Down

0 comments on commit 0ff6072

Please sign in to comment.