From 5cb9cc158a468f1c97addeb865705c3784ec1322 Mon Sep 17 00:00:00 2001 From: Ceda EI Date: Tue, 23 Jul 2019 13:23:12 +0530 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++++++++++++- package.json | 2 +- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8186175..df6d5c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # better-strip-color -Strip ansi characters from a string. \ No newline at end of file +Strip ansi colors, attributes from a string. + +## Install + +Install with [npm](https://www.npmjs.com/) or [pnpm]() + +```sh +$ npm i better-strip-color +``` + +## Usage + +```js +const strip = require("better-strip-color"); +const strippedString = strip(ANSIString); +``` + +## License + +Released under the LGPL-3.0 license. diff --git a/package.json b/package.json index cea9e2a..09cd581 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "better-strip-color", - "version": "1.0.0", + "version": "1.0.1", "description": "Strip ANSI colors, attributes from a string", "main": "index.js", "scripts": {