From 1b9bc2e948974b4f84b234a03dd7418599dc7b06 Mon Sep 17 00:00:00 2001 From: Holly Date: Tue, 1 Aug 2023 14:05:33 +0100 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 0544e59..a743b26 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # dyetty   [![CodeFactor](https://www.codefactor.io/repository/github/tgpholly/dyetty/badge)](https://www.codefactor.io/repository/github/tgpholly/dyetty)   [![Node.js CI](https://github.com/tgpholly/dyetty/actions/workflows/node.js.yml/badge.svg?branch=master)](https://github.com/tgpholly/dyetty/actions/workflows/node.js.yml)   [![npm](https://img.shields.io/npm/v/dyetty)](https://www.npmjs.com/package/dyetty) A drop-in, function compatible alternative to chalk that supports CommonJS + +## Motivations +When version 5 of chalk was released support for CommonJS was dropped. I don't yet (if ever) want to migrate to ESM so I made this. + +## Things to note +When using TypeScript you may need to change the way you import the module if you import chalk like this: +```ts +import chalk from "chalk"; +``` +To importing it like this: +```ts +import * as chalk from "dyetty"; +```