Skip to content

Commit

Permalink
Fix: Rename Package from "colorus" to "colorus-js" to Resolve NPM Con…
Browse files Browse the repository at this point in the history
…flict (#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
  • Loading branch information
supitsdu authored Apr 30, 2024
1 parent 8b0f26c commit 4b27c13
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ jest.config.js
rollup.config.js
*.tgz
*.webp
*.svg
4 changes: 2 additions & 2 deletions @types/main.d.ts
Original file line number Diff line number Diff line change
@@ -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 }
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Colorus
# Colorus-js

<img src="https://raw.githubusercontent.com/supitsdu/colorus/main/favicon.svg" width="196">
<img src="https://raw.githubusercontent.com/supitsdu/colorus-js/main/favicon.svg" width="196">

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.

Expand All @@ -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)');
Expand Down
12 changes: 6 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand All @@ -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",
Expand Down

0 comments on commit 4b27c13

Please sign in to comment.