react-color-palette-wheel 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Milles Dyson Schroeder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,73 +1,55 @@
-# React + TypeScript + Vite
+# 🎨 React Color Palette Wheel
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A professional, lightweight, and fully typed color wheel component for React. Inspired by tools like Adobe Color, this library allows color selection based on **Chromatic Harmonies** (Triad, Complementary, Analogous, etc.) with geometric precision.
 
-Currently, two official plugins are available:
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-color-palette-wheel)
+![npm version](https://img.shields.io/npm/v/react-color-palette-wheel)
+![license](https://img.shields.io/npm/l/react-color-palette-wheel)
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+## ✨ Highlights
 
-## React Compiler
+* **Ultra Lightweight:** Only **~16.4kB** (packed).
+* **Mathematical Harmonies:** Precise algorithms for complex color schemes.
+* **TypeScript:** Native type definitions (`.d.ts`) included.
+* **Performance:** Optimized Canvas rendering.
+* **Zero Config:** Works out of the box with sensible defaults.
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+## 📦 Installation
 
-## Expanding the ESLint configuration
+```bash
+npm install react-color-palette-wheel
+# or
+yarn add react-color-palette-wheel
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+## 🚀 Basic Usage
+
+```ts
+import { useState } from 'react';
+import { ColorWheel, HarmonyType, CursorData } from 'react-color-palette-wheel';
+
+function App() {
+    const [colors, setColors] = useState<CursorData[]>([]);
+
+    return (
+        <div>
+            <h1>Harmony Selector</h1>
+            
+            <ColorWheel
+                radius={250}                 // Wheel radius (Total diameter: 500px)
+                harmony={HarmonyType.Triad}  // Harmony type (e.g., Triad)
+                onChange={setColors}         // Callback with selected colors
+            />
+        </div>
+    );
+}
+```
 
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+## 🛠️ Build Details
+* **Formats:** ESM (.es.js) and UMD (.umd.js).
+* **Size:** ~16kB (Minified + Gzipped).
+* **Typing:** Full TypeScript support.
 
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
-```
+## 📄 License
+MIT

package/package.json

@@ -1,7 +1,29 @@
 {
   "name": "react-color-palette-wheel",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MillesDyson/color-palette-generator.git"
+  },
+  "homepage": "https://github.com/MillesDyson/color-palette-generator",
+  "bugs": {
+    "url": "https://github.com/MillesDyson/color-palette-generator/issues"
+  },
+  "keywords": [
+    "react",
+    "color",
+    "palette",
+    "wheel",
+    "color-palette",
+    "color-palette-generator"
+  ],
+  "author": {
+    "name": "Milles Dyson",
+    "email": "millesdyson@gmail.com",
+    "url": "https://github.com/MillesDyson"
+  },
   "scripts": {
     "dev": "vite",
     "build": "tsc -b && vite build",