From 4b27c13319b9efd1e40021c8ebffae718cbe7efd Mon Sep 17 00:00:00 2001 From: "Eduardo M. Santos" <160991364+supitsdu@users.noreply.github.com> Date: Tue, 30 Apr 2024 01:43:48 -0300 Subject: [PATCH] Fix: Rename Package from "colorus" to "colorus-js" to Resolve NPM Conflict (#5) * fix!: npm conflict with existing package names. * chore: ignores unwanted *.svg vector in future NPM packages * chore(package.json): bump version to 0.7.2 --- .npmignore | 1 + @types/main.d.ts | 4 ++-- README.md | 8 ++++---- package.json | 12 ++++++------ 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/.npmignore b/.npmignore index fe48184..bb0d066 100644 --- a/.npmignore +++ b/.npmignore @@ -10,3 +10,4 @@ jest.config.js rollup.config.js *.tgz *.webp +*.svg diff --git a/@types/main.d.ts b/@types/main.d.ts index 4d132f4..bbfb8b2 100644 --- a/@types/main.d.ts +++ b/@types/main.d.ts @@ -1,7 +1,7 @@ /** - * The `colorus` module allows for easy manipulation and conversion of colors between different formats. + * The `colorus-js` module allows for easy manipulation and conversion of colors between different formats. */ -declare module 'colorus' { +declare module 'colorus-js' { export type RgbObject = { r: number | string; g: number | string; b: number | string; a?: number | string } export type HslObject = { h: number | string; s: number | string; l: number | string; a?: number | string } diff --git a/README.md b/README.md index 1c3112e..5051360 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Colorus +# Colorus-js - + Colorus is a versatile tool designed for seamless color manipulation across various formats. Whether you're handling RGB, HSL, HSV, or CMYK colors, Colorus streamlines the process, offering a hassle-free experience for managing colors in your projects. @@ -16,13 +16,13 @@ The key features of Colorus include: You can install Colorus via npm: ```sh -npm i colorus +npm i colorus-js ``` ## Usage ```js -const { Colorus } = require('colorus'); +const { Colorus } = require('colorus-js'); // Create a new Colorus instance const color = new Colorus('rgb(255 0 0)'); diff --git a/package.json b/package.json index b8bb123..9b82f48 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "colorus", - "version": "0.7.1", - "description": "Sleek and powerful color manipulation library for JavaScript.", + "name": "colorus-js", + "version": "0.7.2", + "description": "Sleek and powerful color manipulation library.", "type": "module", "main": "./dist/index.js", "exports": { @@ -26,12 +26,12 @@ "license": "MIT", "repository": { "type": "git", - "url": "git+https://github.com/supitsdu/colorus.git" + "url": "git+https://github.com/supitsdu/colorus-js.git" }, "bugs": { - "url": "https://github.com/supitsdu/colorus/issues" + "url": "https://github.com/supitsdu/colorus-js/issues" }, - "homepage": "https://github.com/supitsdu/colorus/", + "homepage": "https://github.com/supitsdu/colorus-js/", "keywords": [ "color", "colours",