README.md

🖍️ Crayon

📚 About

Crayon is a terminal styling module written in TypeScript.
From the ground up its goals are to be fast, relatively lightweight and modular.

🖍️ Crayon.js offers:

• ⚡ Great performance
• 📦 No dependencies
• 🗑️ Modularity (use what you need)
• 🧐 Familiar API (chalk-like)
• 🦄 Built-in color fallbacking
  • 🎨 Automatic color detection via @crayon/color-support extension package
• 🔗 Support for nesting & chaining styles
• 🪢 Not extending String.prototype
• 🌈 24bit (16.7mln - truecolor) and 8bit (256 - highcolor) color support

⚙️ Usage

import crayon from "@crayon/crayon";

console.log(crayon.red("its red!"));

🤝 Contributing

Crayon is open for any contributions.
If you feel like you can enhance this project - please open an issue and/or pull request.
Code should be well document and easy to follow what's going on.

Crayon 4.x follows conventional commits.
If your pull request's code could introduce understandability trouble, please add comments to it.

📝 Licensing

This project is available under MIT License conditions.