@nlux/react - npm Package Compare versions

Comparing version 0.8.1 to 0.8.2

package.json

 {
   "name": "@nlux/react",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "NLUX React is a library for building conversational AI interfaces, with support for OpenAI, HuggingFace, and more.",
@@ -57,3 +57,3 @@ "keywords": [
   "dependencies": {
-    "@nlux/core": "0.8.1"
+    "@nlux/core": "0.8.2"
   },
@@ -60,0 +60,0 @@ "peerDependencies": {

README.md

@@ -1,4 +0,4 @@
-# NLUX REACT
+# NLUX REACT ✨💬
 
-## Conversational AI React JS Library For ChatGPT And Other LLMs ✨💬
+## Conversational AI UI Library For ChatGPT And Other LLMs
 
@@ -13,15 +13,11 @@ NLUX _(for Natural Language User Experience)_ is an open-source Javascript library that makes it simple to integrate
 * **React Components & Hooks** - `<AiChat />` for UI and `useAdapter` hook for easy integration.
-* **Flexible LLM Adapters** - Provided adapters for `ChatGPT` and `HuggingFace`, and an API to create
-  your own adapter.
+* **Flexible LLM Adapters** - `ChatGPT` `HuggingFace` and an API to **Create Your Own Adapter** for any LLM.
 * **Streaming LLM Output** - Streamed the chat response to the UI as it's being generated.
-* **Syntax Highlighting** - Color and highlight code snippets in the response. **Copy and paste** code into your
-  editor.
-* **Personalize The Conversation** - Providing context using system message, and instruct the LLM how to behave.
+* **Syntax Highlighting** - Color code snippets in the response. **Copy And Paste** code into your editor.
+* **Personalize The Conversation** - Provide context using system message, and instruct the LLM how to behave.
 * **Zero Dependencies** - Lightweight codebase, with zero-dependencies except for LLM front-end libraries.
 
-## Vanilla JS 🟨 vs React JS ⚛️
+## Docs Website 📖
 
-This package `@nlux/react` is the React JS version of NLUX.
-If you're looking for the Vanilla JS version, please check
-the [`@nlux/core`](https://www.npmjs.com/package/@nlux/core) package.
+Please visit [docs.nlux.ai](https://docs.nlux.ai/) for the full documentation and examples.
 
@@ -75,18 +71,14 @@ ## Get Started With NLUX React and ChatGPT 🚀
 You should include a **theme CSS file** into your HTML page.<br />
-You can download and host the `Kensington Theme` CSS file
-from [`@nlux/themes`](https://www.npmjs.com/package/@nlux/themes) or use the
-CDN hosted version from below:
+The recommended way for React developers is to install `@nlux/themes`
 
-```jsx
-<link rel="stylesheet" href="https://themes.nlux.ai/v0.8.1/kensington.css"/>
+```sh
+npm install @nlux/themes
 ```
 
-This CDN is provided for demo purposes only and it's not scalable.
-Please download and host the theme files on your own for production use.
+Then import the theme CSS file into your app or component as follows:
 
-In the context of React JS, you can directly `import '@nlux/themes/kensington.css'`
-in your app/component, but please make sure that your bundler is configured to handle CSS files.
 
-## Docs Website 📖
-
-Please visit [docs.nlux.ai](https://docs.nlux.ai/) for the full documentation and examples.
+```jsx
+import '@nlux/themes/kensington.css';
+```
+This requires that your bundler is configured to load CSS files.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-66.67%

Worsened metrics

Total package byte prevSize

4327

decreased by-65.93%

Number of package files

3

decreased by-57.14%

Lines of code

2

decreased by-96.92%

Number of lines in readme file

82

decreased by-9.89%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

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

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

• Updated@nlux/core@0.8.2