@nstc-design/icons 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,57 @@
+# @nstc-design/icons
+
+Generated Vue 3 and React icon components from the NSTC Design Icons library.
+
+## Installation
+
+~~~bash
+npm install @nstc-design/icons
+pnpm add @nstc-design/icons
+yarn add @nstc-design/icons
+~~~
+
+Install the peer dependency for the framework entry you use: Vue 3 for @nstc-design/icons/vue, or React 19 for @nstc-design/icons/react.
+
+## Vue 3
+
+Register all icons as a Vue plugin:
+
+~~~ts
+import { createApp } from "vue";
+import NstcIcons from "@nstc-design/icons/vue";
+import App from "./App.vue";
+
+createApp(App).use(NstcIcons).mount("#app");
+~~~
+
+~~~vue
+<icon-name :size="24" />
+~~~
+
+You can also import one icon by its generated name (for example, IconAdd):
+
+~~~ts
+import { IconAdd } from "@nstc-design/icons/vue";
+~~~
+
+## React
+
+~~~tsx
+import { IconAdd } from "@nstc-design/icons/react";
+
+export function Example() {
+  return <IconAdd size={24} />;
+}
+~~~
+
+Replace IconAdd with any icon exported by this package.
+
+## Component props
+
+- **size**: number or CSS size string. Defaults to 1em.
+- **color**: CSS color. Defaults to the current text color.
+- **originColor**: use the icon's original colors instead of a single current color.
+- **button**: render the icon as an accessible button. Defaults to false.
+- **background**: show the button hover/active background. Defaults to true when button is enabled.
+
+The Vue and React entry points include the shared icon button styles automatically.

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "@nstc-design/icons",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "exports": {
     "./vue": {
-      "types": "./dist/vue/index.d.ts",
-      "import": "./dist/vue/index.js"
+      "types": "./packages/vue/index.d.ts",
+      "import": "./packages/vue/index.js"
     },
     "./react": {
-      "types": "./dist/react/index.d.ts",
-      "import": "./dist/react/index.js"
+      "types": "./packages/react/index.d.ts",
+      "import": "./packages/react/index.js"
     },
-    "./style.css": "./dist/style.css",
+    "./style.css": "./packages/style.css",
     "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "packages"
   ],
   "sideEffects": [
-    "./dist/style.css"
+    "./packages/style.css"
   ],
   "peerDependencies": {
     "react": "^19.0.0",