@skillpet/circuit 0.5.0 → 0.5.2

package/LICENSE

@@ -0,0 +1,43 @@
+@skillpet/circuit License
+
+Copyright (c) 2026 SkillPet. All rights reserved.
+
+This software and associated documentation files (the "Software") are the
+proprietary property of SkillPet.
+
+GRANT OF LICENSE
+
+1. PERSONAL & EDUCATIONAL USE — Permission is hereby granted, free of charge,
+   to any individual to use the Software for personal, educational, and
+   non-commercial purposes, subject to the conditions below.
+
+2. COMMERCIAL USE — Any use of the Software in a commercial context (including
+   but not limited to: integration into commercial products or services, use
+   within revenue-generating applications, SaaS platforms, internal business
+   tools, or any project operated by a for-profit entity) requires a separate
+   commercial license. To obtain a commercial license, please contact:
+
+       license@skill.pet
+       https://circuit.skill.pet/license
+
+CONDITIONS
+
+- The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+- Redistribution, sublicensing, or resale of the Software, in whole or in
+  part, whether in source or compiled form, is not permitted without prior
+  written permission from SkillPet.
+
+- Reverse engineering, decompilation, or disassembly of the compiled Software
+  is not permitted.
+
+DISCLAIMER
+
+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,14 +1,16 @@
 # @skillpet/circuit
 
-电路原理图绘制库 — 通过 JSON 描述电路，渲染为交互式 SVG，支持主题、颜色过渡、tooltip，提供 Vue 和 React 组件。
+A circuit diagram library for rendering electrical schematics from JSON. Produces interactive SVG with hover tooltips, click events, theming, and color transitions. Ships with Vue 3 and React components.
 
-## 安装
+**Website & Demos:** [circuit.skill.pet](https://circuit.skill.pet)
+
+## Installation
 
 ```bash
 npm install @skillpet/circuit
 ```
 
-## 快速开始
+## Quick Start
 
 ### ESM / TypeScript
 
@@ -24,10 +26,9 @@ const svg = renderFromJson({
     { type: "Ground" },
   ],
 });
-// svg 是 SVG 字符串，可嵌入 HTML 或写入文件
 ```
 
-### 普通网页
+### Browser (Script Tag)
 
 ```html
 <script src="https://unpkg.com/@skillpet/circuit/dist/circuit.bundle.min.js"></script>
@@ -42,15 +43,17 @@ const svg = renderFromJson({
 </script>
 ```
 
-### 交互模式（带 tooltip、hover 高亮、事件）
+### Interactive Mode
+
+Mount into the DOM with hover highlights, tooltips, and click events:
 
 ```ts
 import { mountFromJson } from "@skillpet/circuit";
 
 const ctrl = mountFromJson(document.getElementById("container"), {
   elements: [
-    { type: "ResistorIEEE", id: "R1", tooltip: "碳膜电阻 100kΩ" },
-    { type: "Capacitor", d: "down", id: "C1", tooltip: "陶瓷电容 0.1μF" },
+    { type: "ResistorIEEE", id: "R1", tooltip: "100kΩ Carbon Film" },
+    { type: "Capacitor", d: "down", id: "C1", tooltip: "0.1μF Ceramic" },
   ],
 }, { interactive: true });
 
@@ -63,12 +66,15 @@ ctrl.on("element:hover", (info) => console.log("Hover:", info.tooltip));
 ```vue
 <script setup>
 import { CircuitDiagram } from "@skillpet/circuit/vue";
+
 const circuit = {
   elements: [
     { type: "ResistorIEEE", label: "R1", id: "R1", tooltip: "100kΩ" },
+    { type: "Capacitor", d: "down", label: "C1" },
   ],
 };
 </script>
+
 <template>
   <CircuitDiagram :circuit="circuit" interactive @element-click="console.log" />
 </template>
@@ -90,16 +96,17 @@ function App() {
 }
 ```
 
-## 主题
+## Themes
 
-```ts
-import { renderFromJson } from "@skillpet/circuit";
+Three built-in themes: `light` (default), `dark`, and `print`.
 
-// 内置主题：'light'、'dark'、'print'
+```ts
 const svg = renderFromJson(circuit, { theme: "dark" });
 ```
 
-## 颜色过渡
+## Color Transitions
+
+Smooth gradient transitions between differently colored elements:
 
 ```ts
 const svg = renderFromJson({
@@ -107,25 +114,12 @@ const svg = renderFromJson({
   elements: [
     { type: "SourceV", d: "up", color: "#2ecc71" },
     { type: "ResistorIEEE", color: "#e74c3c" },
-    // 引线处自动生成渐变过渡
   ],
 }, { colorTransition: true });
 ```
 
-## 开发
-
-```bash
-npm install
-npm run build    # tsc → dist/
-npm run bundle   # esbuild → IIFE/CJS/ESM bundles
-npm test         # vitest
-npm run preview  # Vite 预览页（元件画廊 + 交互演示）
-```
-
-## 要求
-
-- Node.js >= 18
-
-## 许可
+## License
 
-MIT
+Free for personal and educational use. Commercial use requires a separate license.  
+See the LICENSE file included in this package for full terms.  
+For commercial licensing, contact **license@skill.pet** or visit [circuit.skill.pet/license](https://circuit.skill.pet/license).

package/dist/circuit.bundle.js

@@ -31100,4 +31100,3 @@ var Circuit = (() => {
   }
   return __toCommonJS(index_exports);
 })();
-//# sourceMappingURL=circuit.bundle.js.map