ccat-api - npm Package Compare versions

Comparing version 0.7.0 to 0.7.1

dist/index.d.ts

@@ -66,3 +66,4 @@ import WebSocket from 'isomorphic-ws';
     definitions?: Record<string, any>;
-    humanReadableName: string;
+    humanReadableName?: string;
+    link?: string;
 };
@@ -69,0 +70,0 @@

package.json

@@ -5,3 +5,3 @@ {
   "license": "MIT",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "author": "zAlweNy26",
@@ -8,0 +8,0 @@ "main": "dist/index.js",

README.md

@@ -0,8 +1,24 @@
+<a href="https://github.com/cheshire-cat-ai/api-client-ts">
+  <img alt="GitHub Stars" src="https://img.shields.io/github/stars/cheshire-cat-ai/api-client-ts?logo=github&style=flat-square">
+</a>
+<a href="https://discord.gg/bHX5sNFCYU">
+  <img alt="Discord Server" src="https://img.shields.io/discord/1092359754917089350?logo=discord&style=flat-square">
+</a>
+<a href="https://npmjs.com/package/ccat-api">
+  <img alt="NPM Version" src="https://img.shields.io/npm/v/ccat-api?logo=npm&style=flat-square">
+</a>
+<a href="https://npmjs.com/package/ccat-api">
+  <img alt="NPM Downloads" src="https://img.shields.io/npm/dw/ccat-api?logo=npm&style=flat-square">
+</a>
+<a href="https://bundlephobia.com/package/ccat-api">
+  <img alt="Bundle Size" src="https://img.shields.io/bundlephobia/minzip/ccat-api?logo=npm&style=flat-square">
+</a>
+
 # Cheshire Cat AI API Client
 
 API Client made in TypeScript to communicate with the [Cheshire Cat AI](https://github.com/cheshire-cat-ai/core).\
-The package provides a class to interface with the Cheshire Cat Python Server.\
-It can be used both in Browser or NodeJS environment.
+The package provides a class to interface with the Cheshire Cat AI backend.\
+It can be used both in Browser and NodeJS environments.
 
-Every endpoint is a `CancelablePromise`, it means you can cancel the request if you want.
+Every endpoint is a `CancelablePromise`, which means you can cancel the request if you want.
 
@@ -41,3 +57,3 @@ ## Installation
 | **port**     | number   | 1865         | The same of the **CORE_PORT**                                                    |
-| **instant**  | boolean  | true         | Instantly initialize the websocket and the API client, or later with **.init()** |
+| **instant**  | boolean  | true         | Instantly initialize the WebSocket and the API client, or later with **.init()** |
 | **secure**   | boolean  | false        | The same of the **CORE_USE_SECURE_PROTOCOLS**                                    |
@@ -70,3 +86,3 @@ | **timeout**  | number   | 10000        | Timeout for the endpoints, in milliseconds                                       |
 
-You can listen to the websocket events:
+You can listen to the WebSocket events:
 
@@ -73,0 +89,0 @@ ```ts

No alert changes

Improved metrics

Total package byte prevSize

112242

increased by0.78%

Lines of code

3098

increased by0.03%

Number of lines in readme file

112

increased by16.67%

No dependency changes