From 30bd3b18e3d93d199d748a4cec55197efd09df45 Mon Sep 17 00:00:00 2001
From: Bernso <ben.w.sheridan@gmail.com>
Date: Thu, 19 Dec 2024 12:31:15 +0000
Subject: [PATCH] 0.1.3.1 Updated README.md

---
 README.md      | 71 +++++++++++++++++++++++++++++++-------------------
 pyproject.toml |  2 +-
 2 files changed, 45 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index d116f09..d394a5a 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,13 @@ This package is an advanced logging system that allows the user to create custom
 pip install boLogger --upgrade
 ```
 
+# Features
+
+- Colour
+- Create your own custom logger
+- Text wrapping (the text will never be on the same level as the logger info)
+- Easy use
+
 # Options
 
 ### Colours
@@ -34,7 +41,9 @@ CustomLog() includes everything in the Logging() class and more
     color: str, 
     bold: bool, 
     underlined: bool
-) # This is used to create deafults for the custom_log() method and 
+) # This is used to create deafults for the custom_log() method
+  # Meaning if the user wants to use the cutom_log() method 
+  # They only need to use the text parameter 
 
 .custom_log(
     text: str,  
@@ -45,8 +54,9 @@ CustomLog() includes everything in the Logging() class and more
 ) # If you already have a deafult set you will only need to enter the text param
   # But if you have not, you will need to enter all params
         
-
-.view_deafult() # method to view the current deafult settings
+# Method to view the current deafult settings
+# It returns it, not printing
+.view_deafult() 
 
 .add_color(colour) # your own colour code (must start with '\033[')
 ```
@@ -54,31 +64,38 @@ CustomLog() includes everything in the Logging() class and more
 # Example Usage
 
 ```py
-# Make sure to define the class
-mylogger = Logging()
-print(mylogger) # Explains the module
-mylogger.header("Header")
-mylogger.info("Info")
-mylogger.warning("Warning")
-mylogger.error("Error")
-mylogger.success("Success")
-mylogger.beans("Beans")
-mylogger.info("This is a very long log message that is going to spill over to the next line and needs to be properly indented for better readability.")
-
-
-customLogger = CustomLog()
-print(customLogger) # Explains the module
-customLogger.set_default(title="beansareyummy", color='Blue') # Bold and underlined are automatically set to false
-customLogger.view_deafult()
-customLogger.custom_log("custom")
-customLogger.info("custom")
-```
+### Logging()
+print(Logging()) # Explains the module
 
-# Features
+.header("Header")
+
+.info("Info")
+
+.warning("Warning")
+
+.error("Error")
+
+.success("Success")
+
+.beans("Beans")
+
+.info("This is a very long log message that is going to spill over to the next line and needs to be properly indented for better readability.")
+
+
+
+### CustomLog()
+# Explains the module
+print(CustomLog()) 
+
+# Bold and underlined are automatically set to false
+.set_default(title="beansareyummy", color='Blue') 
+
+.view_deafult()
+
+.custom_log("custom")
+
+.info("custom")
+```
 
-- Colour
-- Create your own custom logger
-- Text wrapping (the text will never be on the same level as the logger info)
-- Easy use
 
 
diff --git a/pyproject.toml b/pyproject.toml
index b594cc8..73ab678 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "boLogger" # Use a unique name
-version = "0.1.3" # Start with a low version number
+version = "0.1.3.1" # Start with a low version number
 description = "An advanced logging system used for clear understanding of your logs."
 authors = ["Bernso <Bernso@duck.com>"]
 license = "MIT" # Choose an appropriate license