@lephenix47/color-converter - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "@lephenix47/color-converter",
-  "version": "1.0.0",
-  "description": "This is a versatile color conversion library for JavaScript. It provides a convenient way to convert color values between different color models, including RGB, HEX, HSL, HWB, and HSV. With [Library Name], you can effortlessly convert colors, normalize them to a consistent format, and retrieve color values in various color models.",
+  "version": "1.0.1",
+  "description": "This is a versatile color conversion library for JavaScript. It provides a convenient way to convert color values between different color models, including RGB, HEX, HSL, HWB, and HSV. With @lephenix47/color-converter, you can effortlessly convert colors, normalize them to a consistent format, and retrieve color values in various color models.",
   "main": "dist/index.js",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -1,1 +0,96 @@
-# Color-converter-npm-library_Younes-Lahouiti
+# @lephenix47/color-converter
+
+## Table of Contents
+
+- [@lephenix47/color-converter](#lephenix47color-converter)
+  - [Table of Contents](#table-of-contents)
+  - [Introduction](#introduction)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Importing the Library](#importing-the-library)
+    - [Creating Color Objects](#creating-color-objects)
+    - [Converting Color Models](#converting-color-models)
+  - [Available Conversion Methods](#available-conversion-methods)
+  - [Conclusion](#conclusion)
+
+## Introduction
+
+The `@lephenix47/color-converter` library is a powerful tool for working with color models in JavaScript. It provides various classes and methods to convert between different color models, manipulate color values, and perform color-related operations.
+
+## Installation
+
+To install my NPM Library, you can use NPM or Yarn:
+
+```shell
+npm install @lephenix47/color-converter
+```
+
+or
+
+```shell
+yarn add @lephenix47/color-converter
+```
+
+## Usage
+
+### Importing the Library
+
+To use `@lephenix47/color-converter` in your project, you need to import the necessary classes:
+
+```javascript
+import { ColorConverter } from '@lephenix47/color-converter';
+```
+
+### Creating Color Objects
+
+To represent colors using the `RGB`, `HSL`, `HWB`, and `HSV` color models, you can use JavaScript objects. Each object should contain the appropriate properties for the corresponding color model. Here's an example:
+
+```js
+const rgbColor = { red: 255, green: 0, blue: 0 };
+const hslColor = { hue: 0, saturation: 100, lightness: 50 };
+const hwbColor = { hue: 120, whiteness: 0, blackness: 0 };
+const hsvColor = { hue: 200, saturation: 28, value: 35 };
+```
+
+On the other hand, you can specify the hexadecimal value as a string, with or without the '#' symbol. For example:
+
+```js
+const color = "#0000FF"; // Hexadecimal color with the '#' symbol
+const color2 = "AA83F5"; // Hexadecimal color without the '#' symbol
+```
+
+### Converting Color Models
+
+To convert colors between different color models, follow these steps:
+
+1. Create a `ColorConverter` instance by specifying the source color model and the color values.
+
+It is important that rgb, hsl, hwb and hsv values are create with an object for example:
+
+For example:
+
+```js
+const color = { hue: 200, saturation: 28, lightness: 35 };
+const converter = new ColorConverter('hsl', color);
+```
+
+2. Use the `convertTo` method to convert the color to the desired color model. For example, to convert to the hexadecimal representation:
+
+```js
+const hexColor = converter.convertTo('hex');
+```
+
+## Available Conversion Methods
+
+To get a list of all available color models supported by `@lephenix47/color-converter`, you can use the `getAllColorModels` method. This method returns an array of strings representing the supported color models. For example:
+
+```js
+const allModels = converter.getAllColorModels();
+console.log(allModels);
+```
+
+The `allModels` variable will contain an array of strings representing the available color models
+
+## Conclusion
+
+With `@lephenix47/color-converter`, you can easily work with color models and perform conversions between them. Simplify your color manipulation tasks and explore the vast possibilities of color representation in your JavaScript projects.

No alert changes

Improved metrics

Total package byte prevSize

21303

increased by17.69%

Number of lines in readme file

97

increased by4750%

No dependency changes