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)