anime-cursor 0.1.0 → 0.1.1

package/README.md

@@ -1,10 +1,10 @@
 # AnimeCursor
 
 <div align="center">
-  <img src="title.gif" width="60%" alt="AnimeCursor"/>
+  <img src="https://cdn.jsdelivr.net/gh/shuninyu/anime-cursor@main/title.gif" width="60%" alt="AnimeCursor"/>
 </div>
 
-[[简体中文]](#SChinese)
+[[简体中文]](#animecursorsc)
 
 AnimeCursor is a lightweight animated cursor JS library that enables dynamic mouse pointers for websites.
 
@@ -21,18 +21,30 @@ AnimeCursor has no dependencies on any frameworks, making it suitable for person
 * Prepare PNG sprite sheets in the correct format, and AnimeCursor will automatically generate cursor animations based on your settings
 * Built with native JavaScript, no third-party dependencies
 
----
-
 ## 📦 Installation
 
+### jsDeliver
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/anime-cursor/dist/anime-cursor.umd.min.js"></script>
+```
+
+### npm
+
+```bash
+npm i anime-cursor
+```
+```js
+import AnimeCursor from 'anime-cursor';
+new AnimeCursor({...});
+```
+
 ### Local storage
 
 ```html
 <script src="anime-cursor.umd.min.js"></script>
 ```
 
----
-
 ## 🚀 Basic Usage
 
 Here is an example of how to use AnimeCursor:
@@ -61,8 +73,6 @@ new AnimeCursor({
 </script>
 ```
 
----
-
 ## ⚙️ Configuration Options
 
 ### `cursors` (Required)
@@ -101,8 +111,6 @@ Enables animated cursors on mobile touch devices.
 AnimeCursor automatically detects mobile touch devices (e.g., phones, tablets) and disables animated cursors on them by default.
 If you want animated cursors to be displayed on these devices, add `enableTouch: true`.
 
----
-
 ## 📝 Notes
 
 ### 📁 Files
@@ -145,8 +153,6 @@ If `duration` is not set, the cursor will be treated as a **static cursor**, eve
 * GIFs do not use `frames`, `duration`, or `pingpong`
 * Animation is controlled by the GIF file itself
 
----
-
 ## ❌ Error Handling
 
 * Missing required configuration parameters will directly terminate initialization.
@@ -154,10 +160,10 @@ If `duration` is not set, the cursor will be treated as a **static cursor**, eve
 * All errors are prefixed with `[AnimeCursor]` when logged to the console.
 
 ---
-<h1 id="SChinese">AnimeCursor</h1>
+# AnimeCursor(SC)
 
 <div align="center">
-  <img src="title.gif" width="60%" alt="AnimeCursor"/>
+  <img src="https://cdn.jsdelivr.net/gh/shuninyu/anime-cursor@main/title.gif" width="60%" alt="AnimeCursor"/>
 </div>
 
 AnimeCursor 是一个轻量级动画光标JS，能够让网站拥有动态的鼠标指针。
@@ -175,9 +181,23 @@ AnimeCursor 无需依赖任何框架，适合个人网站、创意作品集以
 * 按照格式准备好 PNG 精灵图表，AnimeCursor 将基于你的设置自动生成光标动画
 * 基于原生JavaScript，无任何第三方依赖
 
----
+## 📦 部署方法
+
+### jsDeliver
 
-## 📦 引入方式
+```html
+<script src="https://cdn.jsdelivr.net/npm/anime-cursor/dist/anime-cursor.umd.min.js"></script>
+```
+
+### npm
+
+```bash
+npm i anime-cursor
+```
+```js
+import AnimeCursor from 'anime-cursor';
+new AnimeCursor({...});
+```
 
 ### 本地部署
 
@@ -185,8 +205,6 @@ AnimeCursor 无需依赖任何框架，适合个人网站、创意作品集以
 <script src="anime-cursor.umd.min.js"></script>
 ```
 
----
-
 ## 🚀 基础用法
 
 下面是一个 AnimeCursor 使用示例：
@@ -214,8 +232,6 @@ new AnimeCursor({
 </script>
 ```
 
----
-
 ## ⚙️ 配置项说明
 
 ### `cursors`（必填）
@@ -254,8 +270,6 @@ debug覆盖会显示鼠标的真实位置以及当前光标类型，以帮助纠
 AnimeCursor 会自动识别移动触屏设备（比如手机、平板电脑）并默认屏蔽这些设备上的动画光标。
 如果你想在这些设备上显示动画光标，可以添加 `enableTouch: true` 。
 
----
-
 ## 📝 注意事项
 
 ### 📁 文件
@@ -298,8 +312,6 @@ AnimeCursor 会根据配置自动为页面元素添加 `data-cursor`：
 * GIF 不使用 `frames`、`duration` 或 `pingpong`
 * 动画由 GIF 自身控制
 
----
-
 ## ❌ 错误处理
 
 * 缺少必填配置会直接终止初始化

package/package.json

@@ -1,13 +1,18 @@
 {
     "name": "anime-cursor",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "A lightweight JS for website animated cursors",
     "main": "dist/anime-cursor.umd.js",
     "module": "dist/anime-cursor.esm.js",
     "files": [
         "dist"
     ],
-    "keywords": ["cursor", "animation", "ui", "javascript"],
+    "keywords": [
+        "cursor",
+        "animation",
+        "ui",
+        "javascript"
+    ],
     "scripts": {
         "build": "rollup -c"
     },