@arcteninc/core 0.0.14 → 0.0.16
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/README.md +81 -15
- package/dist/index.cjs +5 -5
- package/dist/index.mjs +2502 -2498
- package/package.json +81 -80
- package/dist/components/ArctenAgent.d.ts.map +0 -1
- package/dist/lib/useAgent.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -1,15 +1,81 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
|
|
1
|
+
# @arcteninc/core
|
|
2
|
+
|
|
3
|
+
Core package for Arcten Agent components.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @arcteninc/core
|
|
9
|
+
# or
|
|
10
|
+
bun add @arcteninc/core
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @arcteninc/core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
### Complete Example
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
// 1. Import the component
|
|
21
|
+
import { ArctenAgent } from "@arcteninc/core";
|
|
22
|
+
|
|
23
|
+
// 2. Import the styles (REQUIRED - styles are NOT auto-applied)
|
|
24
|
+
import "@arcteninc/core/styles";
|
|
25
|
+
|
|
26
|
+
function App() {
|
|
27
|
+
return <ArctenAgent />;
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**⚠️ Important:** Importing the component does NOT automatically include styles. You must import the CSS separately (see below).
|
|
32
|
+
|
|
33
|
+
### Import Styles
|
|
34
|
+
|
|
35
|
+
**Required:** You MUST import the CSS styles separately for the components to display correctly. The styles are pre-compiled and self-contained - they work regardless of whether you're using Tailwind CSS in your project.
|
|
36
|
+
|
|
37
|
+
#### Option 1: Import in your CSS file (Recommended)
|
|
38
|
+
|
|
39
|
+
```css
|
|
40
|
+
/* In your globals.css or main CSS file */
|
|
41
|
+
@import "@arcteninc/core/styles";
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Option 2: Import in your JavaScript/TypeScript
|
|
45
|
+
|
|
46
|
+
```tsx
|
|
47
|
+
// In your main entry file (e.g., app.tsx, _app.tsx, layout.tsx)
|
|
48
|
+
import "@arcteninc/core/styles";
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Option 3: Import via CDN (if using unpkg or similar)
|
|
52
|
+
|
|
53
|
+
```html
|
|
54
|
+
<link rel="stylesheet" href="https://unpkg.com/@arcteninc/core@latest/dist/core.css" />
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Development
|
|
58
|
+
|
|
59
|
+
To install dependencies:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
bun install
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
To build:
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
bun run build
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
To watch for changes:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
bun run dev
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Notes
|
|
78
|
+
|
|
79
|
+
- The CSS is pre-compiled and includes all necessary Tailwind styles
|
|
80
|
+
- You don't need to configure Tailwind CSS in your project to use this package
|
|
81
|
+
- The styles are self-contained and won't conflict with your existing styles
|