From 1cab1e076e264f612570572a5426f0ab1345868b Mon Sep 17 00:00:00 2001 From: Lasse Edfast <8794658+lasseedfast@users.noreply.github.com> Date: Thu, 28 Nov 2024 09:20:45 +0100 Subject: [PATCH] Updated instructions on how to use. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c435f0..286ce1a 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,18 @@ Use it as as you normaly use ```print()```. To use this module, simply import it and call the desired function with the text you want to print as arguments. Here's an example: +`git clone https://github.com/lasseedfast/colorprinter` + +This will clone this repo as a folder to your computer. When you want to use the colorprinter, make sure that folder is in the same folder as you're working. Then you can use it like: + ```python -from print_color import print_green, print_rainbow +from colorprinter.print_color import print_green, print_rainbow print_green("This is in green!") print_rainbow("This", "will", "be", "in", "multiple", "colors!") ``` -Alternatively, you can import all functions at once using from print_color import *. However, be cautious when using this approach as it imports all public names defined in the module, which can lead to conflicts with other modules or variables in your namespace.* +Alternatively, you can import all functions at once using from print_color import \*. However, be cautious when using this approach as it imports all public names defined in the module, which can lead to conflicts with other modules or variables in your namespace.* ## Customization The colors are defined using ANSI escape codes. You can modify the choose_color function or the color codes within each print function if you wish to customize the colors.