@nlux/hf-react - npm Package Compare versions

Comparing version 0.10.1 to 0.10.2

package.json

 {
   "name": "@nlux/hf-react",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "The Hugging Face adapters for NLUX React, the React JS library for building conversational AI interfaces.",
@@ -57,6 +57,6 @@ "keywords": [
   "dependencies": {
-    "@nlux/hf": "0.10.1"
+    "@nlux/hf": "0.10.2"
   },
   "peerDependencies": {
-    "@nlux/react": "0.10.1",
+    "@nlux/react": "0.10.2",
     "react": "^18.2.0"
@@ -63,0 +63,0 @@ },

README.md

@@ -1,6 +0,36 @@
-# NLUX React Hugging Face Adapter
+# NLUX Hugging Face Adapter
 
-This package is the Hugging Face adapter for NLUX React, the React JS library for building conversational AI
-interfaces. It can only be used in conjunction with the NLUX React.
+This package enables the integration between NLUX and Hugging Face, the AI models platform.  
+More specifically ― the package include the adapter to connect to chat models hosted and exposed
+via [Hugging Face Inference Endpoints](https://huggingface.co/inference-endpoints/dedicated).
 
-Please check the [@nlux/react](https://www.npmjs.com/package/@nlux/react) package for more information.
+For more information on how to use this package, please visit:  
+[docs.nlux.ai/api/adapters/hugging-face](https://docs.nlux.ai/api/adapters/hugging-face)
+
+### Vanilla JS 🟨 vs React JS ⚛️
+
+This package `@nlux/hf-react` is meant for use with the React JS version of NLUX.
+If you're looking for the vanilla JS version, please check
+the [`@nlux/hf`](https://www.npmjs.com/package/@nlux/hf) package.
+
+## About NLUX
+
+NLUX _(for Natural Language User Experience)_ is an open-source Javascript library that makes it simple to integrate
+powerful large language models (LLMs) like ChatGPT into your web app or website. With just a few lines of code, you
+can add conversational AI capabilities and interact with your favourite LLM.
+
+### Key Features 🌟
+
+* **Build AI Chat Interfaces In Minutes** ― High quality conversational AI interfaces with just a few lines of code.
+* **React Components & Hooks** ― `<AiChat />` for UI and `useAdapter` hook for easy integration.
+* **LLM Adapters** ― For `ChatGPT` / `LangChain` 🦜 LangServe / `HuggingFace` 🤗 Inference.
+* A flexible interface to **Create Your Own Adapter** for any LLM or API.
+* **Bot and User Personas** ― Customize the bot and user personas with names, images, and more.
+* **Streaming LLM Output** ― Streamed the chat response to the UI as it's being generated.
+* **Customizable Theme** - Easily customize the look and feel of the chat interface using CSS variables.
+* **Event Listeners** - Listen to messages, errors, and other events to customize the UI and behaviour.
+* **Zero Dependencies** ― Lightweight codebase, with zero-dep except for LLM front-end libraries.
+
+### Docs & Examples 📖
+
+For developer documentation, examples, and API reference ― you can visit: **[NLUX.ai](https://nlux.ai/)**

No alert changes

Improved metrics

Total package byte prevSize

8518

increased by26.36%

Number of lines in readme file

37

increased by428.57%

Dependency changes

• + Added@nlux/core@0.10.2(transitive)

• + Added@nlux/hf@0.10.2(transitive)

• + Added@nlux/react@0.10.2(transitive)

• - Removed@nlux/core@0.10.1(transitive)

• - Removed@nlux/hf@0.10.1(transitive)

• - Removed@nlux/react@0.10.1(transitive)

• Updated@nlux/hf@0.10.2