From b42b4725ff8c234ae674862e776a39b8d8c2bbdf Mon Sep 17 00:00:00 2001
From: Thorben <2708231+eaCe@users.noreply.github.com>
Date: Tue, 5 Dec 2023 07:27:25 +0100
Subject: [PATCH] chore: update readme

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 41d501c..cb21c64 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,8 @@ You may pass an array of values as the first argument.
 
 ### `$log()`
 
+Write a message to the console.
+
 ```html
 <div x-data="{ foo: 'bar' }">
     <button @click="$log(foo)">Log</button>
@@ -35,6 +37,8 @@ You may pass an array of values as the first argument.
 
 ### `$warn()`
 
+Write a warning message to the console.
+
 ```html
 <div x-data="{ foo: 'bar' }">
     <button @click="$warn(foo)">Log</button>
@@ -43,6 +47,8 @@ You may pass an array of values as the first argument.
 
 ### `$error()`
 
+Write an error message to the console.
+
 ```html
 <div x-data="{ foo: 'bar' }">
     <button @click="$error(foo)">Log</button>
@@ -51,6 +57,8 @@ You may pass an array of values as the first argument.
 
 ### `$info()`
 
+Write an informational message to the console.
+
 ```html
 <div x-data="{ foo: 'bar' }">
     <button @click="$info(foo)">Log</button>
@@ -59,6 +67,8 @@ You may pass an array of values as the first argument.
 
 ### `$table()`
 
+Writes a table in the console view.
+
 ```html
 <div x-data="">
     <button @click="$table({ foo: 'bar', bar: 'foo'})">Log</button>
@@ -67,6 +77,8 @@ You may pass an array of values as the first argument.
 
 ### `$clear()`
 
+Clears the console.
+
 ```html
 <div x-data="">
     <button @click="clear();$log('foo')">Clear previous logs and log</button>
@@ -75,6 +87,8 @@ You may pass an array of values as the first argument.
 
 ### `$group()` and `$groupEnd()`
 
+Creates a new group in the console view.
+
 ```html
 <div x-data="">
     <button @click="$group('Groupname');$log('foo');$log('bar');$groupEnd()">Group logs</button>
@@ -85,6 +99,8 @@ You may pass an array of values as the first argument.
 
 ### `$width` and `$width()`
 
+Get or set the width of an element.
+
 ```html
 <div x-data x-text="$width"></div>
 <div x-data x-init="$width('200px')"></div>
@@ -92,6 +108,8 @@ You may pass an array of values as the first argument.
 
 ### `$height` and `$height()`
 
+Get or set the height of an element.
+
 ```html
 <div x-data x-text="$height"></div>
 <div x-data x-init="$height('200px')"></div>
@@ -101,6 +119,8 @@ You may pass an array of values as the first argument.
 
 ### `$offset().top` and `$offset().left`
 
+Get the offset of an element.
+
 ```html
 <div x-data x-text="$offset().top"></div>
 <div x-data x-text="$offset().left"></div>
@@ -110,13 +130,16 @@ You may pass an array of values as the first argument.
 
 ### `$hasClass()`
 
+Checks if an element has a class.
+
 ```html
 <div x-data x-text="$hasClass('foo')" class="foo"></div>
 ```
 
 ### `$trim()`
 
+Trims whitespace from the beginning and end of a string.
+
 ```html
 <div x-data x-text="$trim(' foo ')"></div>
 ```
- 
\ No newline at end of file