brandbot 0.1.0 โ†’ 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +5 -1
  2. package/package.json +38 -8
package/README.md CHANGED
@@ -1,10 +1,14 @@
1
1
  # BrandBot ๐Ÿค–
2
2
 
3
+ [![npm](https://img.shields.io/npm/v/brandbot?color=cb3837&logo=npm)](https://www.npmjs.com/package/brandbot)
4
+ [![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
5
+ [![TypeScript](https://img.shields.io/badge/TypeScript-3178c6?logo=typescript&logoColor=white)](#)
6
+
3
7
  **A 3D robot mascot you brand with your own logo and colors.** A drop-in React component that gestures, blinks, and follows the visitor's cursor. It renders with [Three.js](https://threejs.org), is written in TypeScript with full type declarations, and bundles the model โ€” so there's nothing to configure or host. Works in any React app (see the Next.js note below).
4
8
 
5
9
  **[โ–ถ Live demo](https://aidan945.github.io/brandbot/demo/)** ยท **[Configure & copy code](https://aidan945.github.io/brandbot/demo/configure.html)**
6
10
 
7
- ![BrandBot](./preview.png)
11
+ ![BrandBot](https://raw.githubusercontent.com/Aidan945/brandbot/main/preview.png)
8
12
 
9
13
  ## Install
10
14
 
package/package.json CHANGED
@@ -1,21 +1,37 @@
1
1
  {
2
2
  "name": "brandbot",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "๐Ÿค– A 3D robot mascot you brand with your own logo and colors โ€” a drop-in React component with cursor tracking, built on Three.js.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "module": "./dist/index.js",
8
8
  "types": "./dist/index.d.ts",
9
9
  "exports": {
10
- ".": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
11
- "./core": { "types": "./dist/robot-core.d.ts", "default": "./dist/robot-core.js" },
10
+ ".": {
11
+ "types": "./dist/index.d.ts",
12
+ "default": "./dist/index.js"
13
+ },
14
+ "./core": {
15
+ "types": "./dist/robot-core.d.ts",
16
+ "default": "./dist/robot-core.js"
17
+ },
12
18
  "./model": "./dist/nexbot-model.js"
13
19
  },
14
- "files": ["dist", "README.md", "LICENSE", "preview.png"],
20
+ "files": [
21
+ "dist",
22
+ "README.md",
23
+ "LICENSE",
24
+ "preview.png"
25
+ ],
15
26
  "sideEffects": false,
16
27
  "homepage": "https://aidan945.github.io/brandbot/demo/",
17
- "repository": { "type": "git", "url": "https://github.com/Aidan945/brandbot.git" },
18
- "bugs": { "url": "https://github.com/Aidan945/brandbot/issues" },
28
+ "repository": {
29
+ "type": "git",
30
+ "url": "https://github.com/Aidan945/brandbot.git"
31
+ },
32
+ "bugs": {
33
+ "url": "https://github.com/Aidan945/brandbot/issues"
34
+ },
19
35
  "author": "Aidan Zarski",
20
36
  "scripts": {
21
37
  "build": "tsc && cp src/nexbot-model.js dist/nexbot-model.js && cp src/nexbot-model.d.ts dist/nexbot-model.d.ts",
@@ -27,13 +43,27 @@
27
43
  "three": ">=0.150.0"
28
44
  },
29
45
  "peerDependenciesMeta": {
30
- "react": { "optional": true }
46
+ "react": {
47
+ "optional": true
48
+ }
31
49
  },
32
50
  "devDependencies": {
33
51
  "typescript": "^5.4.5",
34
52
  "@types/react": "^18.3.3",
35
53
  "@types/three": "^0.160.0"
36
54
  },
37
- "keywords": ["robot", "mascot", "3d", "threejs", "react", "hero", "brand", "logo", "cursor", "spline", "typescript"],
55
+ "keywords": [
56
+ "robot",
57
+ "mascot",
58
+ "3d",
59
+ "threejs",
60
+ "react",
61
+ "hero",
62
+ "brand",
63
+ "logo",
64
+ "cursor",
65
+ "spline",
66
+ "typescript"
67
+ ],
38
68
  "license": "MIT"
39
69
  }