From 4ca78e8a263d3504c09c5762f9866acc7ff5a040 Mon Sep 17 00:00:00 2001
From: Jaren Goldberg <fyrlex@gmail.com>
Date: Tue, 2 Jul 2024 20:41:38 -0400
Subject: [PATCH] Update README.md

---
 README.md | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 039b214..ff0ded6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
-# loggage
-If ur reading this, you're doing it wrong.
\ No newline at end of file
+# Loggage
+A simple logging library for Node.js. This package is used with [CountBot](https://count.bot) and open sourced for public use.
+
+# Install
+Install loggage by entering `npm i @countbot/loggage` into your CLI.
+
+# Usage
+```ts
+const logger = new Logger({ name: 'My Project', verbosity: Verbosity.INFO, logToFile: false });
+
+logger.warning('This is a warning message');
+```
+
+# Output
+![image](https://github.com/Count-Bot/loggage/assets/31144090/854c0c47-2e39-4d82-9bf5-5ffb92783b6b)