Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
salmenus committed Feb 14, 2024
1 parent 1db2d50 commit 202871f
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [nlux](https://nlux.ai) 🌲✨💬
# [`nlux`](https://nlux.ai) 🌲✨💬

![Free And Open Source](https://img.shields.io/badge/Free%20%26%20Open%20Source-1ccb61)
[![npm version](https://img.shields.io/badge/NPM-@nlux/react-1ccb61)](https://www.npmjs.com/package/@nlux/react)
Expand All @@ -20,7 +20,8 @@ of code, you can add conversational AI capabilities and interact with your favou
* A flexible interface to **Create Your Own Adapter** for any LLM or API, with support for stream or fetch modes.
* **Bot and User Personas** ― Customize the bot and user personas with names, images, and descriptions.
* **Streaming LLM Output** ― Stream the chat response to the UI as it's being generated.
* **Zero Dependencies** ― Lightweight codebase, with zero-dependencies except for LLM front-end libraries.
* **High Customizability** - Tune almost every UI aspect through theming, layout options, and more.
* **Zero Dependencies** ― Lightweight codebase ― **Core** with zero dependencies and no external UI libraries.

[![200+ Unit Tests](https://github.com/nluxai/nlux/actions/workflows/run-all-tests.yml/badge.svg)](https://github.com/nluxai/nlux/actions/workflows/run-all-tests.yml)

Expand Down Expand Up @@ -89,10 +90,10 @@ cross platforms, with a focus on performance and usability.
## Community & Support 🙏

* **Star The Repo** 🌟 ― If you like `nlux`, please star the repo to show your support.
Your support is what keeps this open-source project going ! 🧡
Your support is what keeps this open-source project going 🧡
* **[GitHub Discussions](https://github.com/nluxai/nlux/discussions)** ― Ask questions, report issues, and share your
ideas with the community.
* **[Discord Community](https://discord.gg/VY4TDaf4)** ― Join our Discord server to chat with the community and get
* **[Discord Community](https://discord.gg/SRwDmZghNB)** ― Join our Discord server to chat with the community and get
support.
* **[nlux.dev](https://nlux.dev/)** Developer Website ― Examples, learning resources, and API reference.

Expand Down
14 changes: 6 additions & 8 deletions pipeline/npm/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## The Conversational AI UI Library For Any LLM

nlux _(for Natural Language User Experience)_ is an open-source Javascript library that makes it super simple to
`nlux` _(for Natural Language User Experience)_ is an open-source Javascript library that makes it super 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.

Expand All @@ -26,25 +26,23 @@ of code, you can add conversational AI capabilities and interact with your favou

* Developer portal ― [nlux.dev](https://nlux.dev/)
* Examples and live code playgrounds ― [nlux.dev/examples](https://nlux.dev/examples)


* [Standard LLM adapters available](https://nlux.dev/learn/adapters)
* [How to create your own adapter for nlux](https://nlux.dev/learn/adapters/custom-adapters/create-custom-adapter)

## Vanilla JS 🟨 vs React JS ⚛️

This package `@nlux/core` is the vanilla JS version of nlux.
This package `@nlux/core` is the vanilla JS version of the library.
If you're looking for the React JS version, please check
the [`@nlux/react`](https://www.npmjs.com/package/@nlux/react) package.

## Get Started With nlux 🚀
## Get Started With `nlux JS` 🚀

The example below demonstrates how to create an AI chat interface using nlux JS and LangChain, the open source
framework for building LLM backends. But you can use nlux **with any LLM** ― either
The example below demonstrates how to create an AI chat interface using `nlux JS` and LangChain, the open source
framework for building LLM backends. But you can use `nlux` **with any LLM** ― either
via the [standard adapters](https://nlux.dev/learn/adapters) provided, or
by creating [your own adapter](https://nlux.dev/learn/adapters/custom-adapters/create-custom-adapter).

To get started with nlux JS and LangChain, install the `@nlux/core` and `@nlux/langchain` packages:
To get started with `nlux JS` and `LangChain`, install the `@nlux/core` and `@nlux/langchain` packages:

```sh
npm install @nlux/core @nlux/langchain
Expand Down
11 changes: 6 additions & 5 deletions pipeline/npm/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@

## The Conversational AI UI Library For Any LLM

nlux _(for Natural Language User Experience)_ is an open-source React and Javascript library that makes it super simple
`nlux` _(for Natural Language User Experience)_ is an open-source React and Javascript library that makes it super
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.
Expand Down Expand Up @@ -33,14 +34,14 @@ of code, you can add conversational AI capabilities and interact with your favou
* [Standard LLM adapters available](https://nlux.dev/learn/adapters)
* [How to create your own adapter for nlux](https://nlux.dev/learn/adapters/custom-adapters/create-custom-adapter)

## Get Started With nlux React 🚀
## Get Started With `nlux React` 🚀

The example below demonstrates how to create an AI chat interface using nlux JS and LangChain, the open source
framework for building LLM backends. But you can use nlux **with any LLM** ― either
The example below demonstrates how to create an AI chat interface using `nlux React` and `LangChain`, the open source
framework for building LLM backends. But you can use `nlux` **with any LLM** ― either
via the [standard adapters](https://nlux.dev/learn/adapters) provided, or
by creating [your own adapter](https://nlux.dev/learn/adapters/custom-adapters/create-custom-adapter).

To get started with nlux JS and LangChain, install the `@nlux/react` and `@nlux/langchain-react` packages:
To get started with `nlux React` and LangChain, install the `@nlux/react` and `@nlux/langchain-react` packages:

```sh
npm install @nlux/react @nlux/langchain-react
Expand Down

0 comments on commit 202871f

Please sign in to comment.