gleap 18.0.1 → 18.1.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 (9) hide show
  1. package/README.md +9 -5
  2. package/build/browser/index.js +1 -1
  3. package/build/browser/index.js.map +1 -1
  4. package/build/cjs/index.js +1 -1
  5. package/build/cjs/index.js.map +1 -1
  6. package/build/esm/index.mjs +1 -1
  7. package/build/esm/index.mjs.map +1 -1
  8. package/index.d.ts +10 -0
  9. package/package.json +9 -4
package/README.md CHANGED
@@ -1,20 +1,22 @@
1
- # Gleap JavaScript SDK
1
+ # Gleap JavaScript and TypeScript SDK
2
2
 
3
3
  ![Gleap JavaScript SDK Intro](https://github.com/GleapSDK/JavaScript-SDK/blob/master/resources/banner.png?raw=true)
4
4
 
5
- Welcome to the Gleap JavaScript SDK. Integrate AI-native customer support and feedback into your app in minutes. Leverage Kai, our autonomous AI agent, to resolve customer inquiries, automate complex workflows, and assist your support team with copilot-powered answers. Combine that with a built-in Help Center, outbound messaging, product roadmaps, bug tracking, and a unified multichannel inbox — everything your team needs to build better software, faster. Let's code, innovate, and grow together!
5
+ Add AI-native customer support, live chat, in-app bug reporting, a help center and surveys to websites and web apps using JavaScript or TypeScript with [Gleap](https://www.gleap.ai). Gleap is an Intercom alternative for software teams that connects customer conversations and feedback with product development.
6
+
7
+ [SDK documentation](https://docs.gleap.ai/documentation/javascript/README) · [Website](https://www.gleap.ai) · [Plans and pricing](https://www.gleap.ai/pricing)
6
8
 
7
9
  ## 📖 Docs & Examples
8
10
 
9
- Checkout our [documentation](https://docs.gleap.io/javascript) for full reference.
11
+ Checkout our [documentation](https://docs.gleap.ai/documentation/javascript/README) for full reference.
10
12
 
11
13
  ## 🚀 Getting started
12
14
 
13
- 1.) Register an account at [www.gleap.io](https://www.gleap.io). It's free and takes just a few seconds.
15
+ 1.) Create a Gleap account and project. See the [current plans and trial terms](https://www.gleap.ai/pricing).
14
16
 
15
17
  2.) Include the Gleap JS SDK within your apps.
16
18
 
17
- ### Installation via nom
19
+ ### Installation via npm
18
20
 
19
21
  Install the **Gleap** package via npm or yarn.
20
22
  ```
@@ -26,6 +28,8 @@ Import the **Gleap** package.
26
28
  import Gleap from 'gleap';
27
29
  ```
28
30
 
31
+ **TypeScript projects:** the package types the `<gleap-*>` elements for both React 18 and React 19. This requires `@types/react` 18.2.6 or newer (17.0.51+ / 16.14.41+ on older React lines). If you see errors like `Type '"span"' is not assignable to type 'ElementType'` after installing, run `npm i -D @types/react@latest`.
32
+
29
33
  ### Initialize the SDK
30
34
 
31
35
  Add the following code to initialize the Gleap JavaScript SDK. Replace "SDK-TOKEN" with your actual SDK token from the [Gleap dashboard](https://app.gleap.io).