@carandesign/drawui 0.1.0 → 0.1.1

package/README.md

@@ -1,73 +1,24 @@
-# React + TypeScript + Vite
+# DrawUI
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+**Sketch-style React UI component library**  
+DrawUI provides a set of hand-drawn sketch-inspired UI components for React, including Buttons, IconButtons, Cards, Inputs, Collapsibles, Dividers, and a library of reusable SVG icons.
 
-Currently, two official plugins are available:
+---
 
-- [@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
+## Features
 
-## React Compiler
+- Hand-drawn sketch style using `roughjs`
+- Themeable: colors, stroke widths, radii, roughness
+- Fully typed with TypeScript
+- Ready-to-use Icons in SVG
+- Supports different sizes and variants
+- Flexible: header/footer support for Cards, collapsible content, icon buttons
 
-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).
+---
 
-## Expanding the ESLint configuration
+## Installation
 
-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:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-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...
-    },
-  },
-])
-```
+```bash
+npm install @carandesign/drawui
+# or
+yarn add @carandesign/drawui

package/package.json

@@ -1,31 +1 @@
-{
-"name": "@carandesign/drawui",
-  "version": "0.1.0",
-  "description": "Sketch-style React UI component library",
-  "type": "module",
-  "main": "dist/drawui.cjs.js",
-  "module": "dist/drawui.es.js",
-  "types": "dist/index.d.ts",
-  "files": ["dist"],
-  "sideEffects": false,
-  "scripts": {
-    "build": "vite build",
-    "prepublishOnly": "npm run build"
-  },
-  "peerDependencies": {
-    "react": "^18 || ^19",
-    "react-dom": "^18 || ^19"
-  },
-  "dependencies": {
-    "roughjs": "^4.6.6"
-  },
-  "devDependencies": {
-    "@types/react": "^19.2.5",
-    "@types/react-dom": "^19.2.3",
-    "@vitejs/plugin-react": "^5.1.1",
-    "vite": "^7.2.4",
-    "vite-plugin-dts": "^4.5.4",
-    "typescript": "~5.9.3",
-    "eslint": "^9.39.1"
-  }
-}
+{"name":"@carandesign/drawui","version":"0.1.1","description":"Sketch-style React UI component library","type":"module","main":"dist/drawui.cjs.js","module":"dist/drawui.es.js","types":"dist/index.d.ts","files":["dist"],"sideEffects":false,"scripts":{"build":"vite build","prepublishOnly":"npm run build"},"peerDependencies":{"react":"^18 || ^19","react-dom":"^18 || ^19"},"dependencies":{"roughjs":"^4.6.6"},"devDependencies":{"@types/react":"^19.2.5","@types/react-dom":"^19.2.3","@vitejs/plugin-react":"^5.1.1","vite":"^7.2.4","vite-plugin-dts":"^4.5.4","typescript":"~5.9.3","eslint":"^9.39.1"}}