@namiruai/chat 1.13.0 → 1.14.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.
Files changed (2) hide show
  1. package/README.md +32 -42
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,65 +1,55 @@
1
1
  # @namiruai/chat
2
2
 
3
- Core chat widget for [Namiru.ai](https://namiru.ai).
3
+ Standalone embeddable chat widget for [Namiru.ai](https://namiru.ai). Uses Shadow DOM for style isolation.
4
4
 
5
- Namiru.ai lets you create AI-powered chat agents for your website in under 30 seconds. Paste your URL, and Namiru crawls your site to build a knowledge base. Your agent answers customer questions 24/7, collects leads through natural conversation, and tracks pain points so you can improve your product. One line of code to embed.
5
+ Namiru.ai lets you create AI-powered chat agents for your website in under 30 seconds. Paste your URL, and Namiru crawls your site to build a knowledge base. One line of code to embed.
6
6
 
7
- ## Installation
7
+ **But customer support is only half the product.** The real value is in what happens after conversations:
8
8
 
9
- ```bash
10
- npm install @namiruai/chat
11
- ```
12
-
13
- ## Usage
9
+ - **Conversation intelligence** - The system monitors every chat and notifies you by email when users encounter issues, discover missing information, or report bugs. It gives you valuable insights into your customers' behavior.
10
+ - **Lead collection** - The chatbot collects name, email, phone, company (whatever you configure) during natural conversation. If someone didn't sign up because they hit a bug, you still have their contact info and can reach out to convert them.
11
+ - **Pain point detection** - Tracks recurring problems across all conversations, groups them by topic, and surfaces what matters most so you can fix issues fast.
12
+ - **AI summaries** - Every conversation is analyzed. You never have to read a single chat log.
14
13
 
15
- ### Script Tag
14
+ ## Recommended: Use the script tag
16
15
 
17
- Add the widget to any website with a single script tag:
16
+ The simplest way to add Namiru to any website:
18
17
 
19
18
  ```html
20
- <script
21
- src="https://cdn.jsdelivr.net/npm/@namiruai/chat/dist/namiru-chat.umd.js"
22
- data-agent-id="your-agent-id"
23
- data-position="bottom-right"
24
- ></script>
19
+ <script src="https://namiru.ai/widget.js"></script>
20
+ <script>
21
+ NamiruChat.init({ agentId: 'your-agent-id' });
22
+ </script>
25
23
  ```
26
24
 
27
- ### ESM Import
28
-
29
- ```js
30
- import { init } from '@namiruai/chat';
25
+ ## Or use a framework wrapper
31
26
 
32
- init({
33
- agentId: 'your-agent-id',
34
- position: 'bottom-right',
35
- });
36
- ```
37
-
38
- ### Inline Mode
27
+ For React, Vue, or Angular projects, use the dedicated wrapper instead of this package:
39
28
 
40
- Embed the chat directly into a container element:
29
+ - **React**: `npm install @namiruai/react` - [@namiruai/react](https://www.npmjs.com/package/@namiruai/react)
30
+ - **Vue**: `npm install @namiruai/vue` - [@namiruai/vue](https://www.npmjs.com/package/@namiruai/vue)
31
+ - **Angular**: `npm install @namiruai/angular` - [@namiruai/angular](https://www.npmjs.com/package/@namiruai/angular)
41
32
 
42
- ```js
43
- import { init } from '@namiruai/chat';
33
+ ## Configuration
44
34
 
45
- const widget = init({
46
- agentId: 'your-agent-id',
47
- mode: 'inline',
48
- container: document.getElementById('chat-container'),
49
- width: '100%',
50
- height: '500px',
51
- });
52
- ```
35
+ | Option | Type | Description |
36
+ |--------|------|-------------|
37
+ | `agentId` | `string` | **Required.** Your Namiru agent ID. |
38
+ | `mode` | `'button' \| 'inline'` | Display mode. Default: `'button'`. |
39
+ | `position` | `'bottom-left' \| 'bottom-right'` | Button position. Default: `'bottom-right'`. |
40
+ | `width` | `string` | Width for inline mode. |
41
+ | `height` | `string` | Height for inline mode. |
53
42
 
54
- ## Framework Wrappers
43
+ ## Get your agent ID
55
44
 
56
- - **React**: [@namiruai/react](https://www.npmjs.com/package/@namiruai/react)
57
- - **Vue**: [@namiruai/vue](https://www.npmjs.com/package/@namiruai/vue)
58
- - **Angular**: [@namiruai/angular](https://www.npmjs.com/package/@namiruai/angular)
45
+ 1. Go to [namiru.ai](https://namiru.ai)
46
+ 2. Paste your website URL
47
+ 3. Your agent is ready in 30 seconds
48
+ 4. Copy the agent ID from the dashboard
59
49
 
60
50
  ## Documentation
61
51
 
62
- For full documentation, visit [namiru.ai](https://namiru.ai).
52
+ Full docs at [namiru.ai/docs/widgets](https://namiru.ai/docs/widgets).
63
53
 
64
54
  ## License
65
55
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@namiruai/chat",
3
- "version": "1.13.0",
3
+ "version": "1.14.0",
4
4
  "description": "Namiru AI chat widget - standalone embeddable widget with Shadow DOM isolation",
5
5
  "main": "dist/namiru-chat.umd.js",
6
6
  "module": "dist/namiru-chat.esm.js",