Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.13 KB

README.md

File metadata and controls

44 lines (26 loc) · 2.13 KB

Simpllog

📝 A simple and VERY lightweight logger for Typescript and Javascript.

npm version Bundlephobia license PRs welcome

🚩 Table of Contents

🤖 Why Use Simpllog?

Simpllog is exactly as the name says. A simple logger. Simpllog is perfect for situations where you need to keep size as low as possible coming in at a tiny 442 bytes when minified! it's perfect for extreme size constraints. While Simpllog doesn't feature advanced features like JSON Output or tracing it's more than enough for any basic program such as a discord bot.

🔧 Contributing

Simpllog is open source, so you can create a pull request (PR). Simply install the npm packages with pnpm and your good to go!

Setup

Fork main branch into your personal repository. Clone it to local computer and install node modules.

$ git clone https://github.com/{your-personal-repo}/simpllog.git
$ npm i -g pnpm
$ pnpm i

Develop

Simply make your changes and test them with this file

Pull Request

Before uploading your PR, run test one last time to check if there are any errors. If it has no errors, commit and push it! When submitting your PR make sure to send a screenshot of the output of the test file. If you added a new log level then make sure to send an updated version of the test file with your PR!

📜 License

This software is licensed under the MIT License.