Commits

sirgazil committed d52c7ba Draft

Updated usage section

  • Participants
  • Parent commits 7a92334

Comments (0)

Files changed (1)

docs/source/usage.rst

 Usage
 =====
 
+``colorin`` uses
+`ANSI escape sequences <http://en.wikipedia.org/wiki/ANSI_escape_code>`_
+internally to format, color and apply other options to the output displayed
+in text terminals.
+
+
+Applying color
+--------------
+
+The following code shows a typical usage of ``colorin`` to display a string
+in color; green, in this case.
+
 .. sourcecode:: python
 
    #! /usr/bin/env python
 
    screen = Display()
    screen.color("Hello world!", "Green")
+
+
+The set of colors available is limited to the following list:
+
+* Black
+* Red
+* Green
+* Yellow
+* Blue
+* Magenta
+* Cyan
+* White