@openmaxai/mascot 0.0.0-stage → 0.1.0-beta.0

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 OpenMax
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,45 @@
1
- # Temporary Holding Version
1
+ # @openmaxai/mascot
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The OpenMax mascot: an animated, state-driven brand character for agent avatars and for loading, empty and
4
+ error states. It renders into SVG, has no runtime dependencies and does not depend on React.
5
+
6
+ > [!WARNING]
7
+ > **Beta.** This is an early preview. The exports, option names and state names may change without notice
8
+ > before 1.0.0.
9
+
10
+ ## Install
11
+
12
+ ```bash
13
+ pnpm add @openmaxai/mascot@next
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ As a custom element:
19
+
20
+ ```js
21
+ import { defineOpenMaxAvatar } from "@openmaxai/mascot";
22
+
23
+ defineOpenMaxAvatar(); // registers <openmax-avatar>
24
+ ```
25
+
26
+ ```html
27
+ <openmax-avatar character="logo" state="thinking" size="64"></openmax-avatar>
28
+ ```
29
+
30
+ Or imperatively, into any element:
31
+
32
+ ```js
33
+ import { createAvatar } from "@openmaxai/mascot";
34
+
35
+ const avatar = createAvatar(document.getElementById("stage"), { character: "logo", state: "idle" });
36
+ avatar.setState("thinking");
37
+ // later
38
+ avatar.destroy();
39
+ ```
40
+
41
+ `STATES` lists the available states. `MASCOT_VERSION` is the package version.
42
+
43
+ ## License
44
+
45
+ MIT. See [LICENSE](./LICENSE).