itivruttah v0.4.1

Itivruttah is a open-source, dynamically modifiable logging system for NodeJS applications.

This project is under construction, so there are a lot of things missing. More improvements will be done and existing docs and features will be improved before releasing Itivruttah.

💿 Installation

npm install --save itivruttah

or if you are using yarn then

yarn add itivruttah

🏍 Quick Start

After installing Itivruttah using the above commands, you can use it in the following way:

// Require the itivruttah logging system
const itivruttah = require('itivruttah');

// Create a new instance of the Logger
let logger = new itivruttah.createNewLogger({
    // Optional configuration
});


// Example to log a critical message
logger.logCritical("This is a critical message.");

// Example to log a warning message
logger.logWarning("This is an example warning message.");

// Example to log a verbose message, which will be only shown
// When there is "--verbose" flag is found in the command-line arguments
logger.logVerbose("This is a message that should be useful to devs.");

// Example to log an OK message
logger.logOK("This is a message that is not an info, but says OK!");

// Example to log an informational message
logger.logInfo("This is an example of an informational statement.");

// Example to log a success message
logger.logSuccess("This is a success message, that makes everyone happy.");

To know what optional configuration options can be passed and how you can dynamically change the theme (layout of the log message) and styles, checkout the customization page.

🐛 Issues

Please raise an issue in this repository for any suggestions and changes needed to be made.

🎉 Support Itivruttah

If you have a 💖 heart and value my work. 🙏 Please, help me with a small donation on PayPal. It'll help motivate me to update the project with many improvements. Please click the below button to redirect to my personal PayPal account, where you can securely donate me.

📝 License

The Itivruttah project is developed and released under the "MIT" license.