diff --git a/README.rst b/README.rst index 8e1f49d..fb36b17 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ You can install ColorPattern using pip: ``pip install colorpattern`` -USAGE +Usage ----- .. code:: python @@ -40,6 +40,59 @@ Patterns - ``style``: Text style (e.g., ‘bright’, ‘dim’, ‘reset_all’). - ``underline``: Set to ``True`` for underlining matched text. +Colors (colorama): +------------------ + +Text Colors (Fore): +~~~~~~~~~~~~~~~~~~~ + +- Fore.BLACK +- Fore.RED +- Fore.GREEN +- Fore.YELLOW +- Fore.BLUE +- Fore.MAGENTA +- Fore.CYAN +- Fore.WHITE +- Fore.LIGHTBLACK_EX +- Fore.LIGHTRED_EX +- Fore.LIGHTGREEN_EX +- Fore.LIGHTYELLOW_EX +- Fore.LIGHTBLUE_EX +- Fore.LIGHTMAGENTA_EX +- Fore.LIGHTCYAN_EX +- Fore.LIGHTWHITE_EX +- Fore.RESET + +Background Colors (Back): +~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Back.BLACK +- Back.RED +- Back.GREEN +- Back.YELLOW +- Back.BLUE +- Back.MAGENTA +- Back.CYAN +- Back.WHITE +- Back.LIGHTBLACK_EX +- Back.LIGHTRED_EX +- Back.LIGHTGREEN_EX +- Back.LIGHTYELLOW_EX +- Back.LIGHTBLUE_EX +- Back.LIGHTMAGENTA_EX +- Back.LIGHTCYAN_EX +- Back.LIGHTWHITE_EX +- Back.RESET + +Text Styles (Style): +~~~~~~~~~~~~~~~~~~~~ + +- Style.RESET_ALL +- Style.BRIGHT +- Style.DIM +- Style.NORMAL + License -------