diff --git a/package.json b/package.json index 69889f0..854047c 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "chalk", + "name": "@nasc/chalk", "version": "2.3.0", "description": "Terminal string styling done right", "license": "MIT", diff --git a/readme.md b/readme.md index 2754499..26b239b 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,13 @@ + +## IMPORTANT + +This is the same chalk from [](https://github.com/chalk/chalk). +The only change made to it is the support for "wrappers" in the effects. + +There is a Pull Request opened to add it to Chalk, but while it is not merged (or in case it does not get approved) we can use this fork instead. +If you want to help, you can check the [Pull Request](https://github.com/chalk/chalk/pull/252) and [the issue](https://github.com/chalk/chalk/issues/253). +This is being **temporarily** published in _npm_ so we can test it out a little further. +



@@ -151,7 +161,7 @@ Levels are as follows: ### chalk.wrapper -The wrapper marks the unprintable characters. +The wrapper marks the unprintable characters from style tags. A wrapper can be added to the styles, so you can escape characters or add marks to then. By default, these wrappers are empty strings `""`.