From d79804e271000ccabc5056a3b19ab213202b31c2 Mon Sep 17 00:00:00 2001
From: Alex Yang <himself65@outlook.com>
Date: Sun, 14 Jan 2024 18:10:55 -0600
Subject: [PATCH] docs: update README.md (#376)
---
README.md | 5 +++++
packages/core/README.md | 34 +++++++++++++++++++++++++++++++++-
2 files changed, 38 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 021eb5727..ce1ea2b50 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
# LlamaIndex.TS
+[](https://www.npmjs.com/package/llamaindex)
+[](https://www.npmjs.com/package/llamaindex)
+[](https://www.npmjs.com/package/llamaindex)
+[](https://discord.com/invite/eN6D2HQ4aX)
+
LlamaIndex is a data framework for your LLM application.
Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
diff --git a/packages/core/README.md b/packages/core/README.md
index d17989ece..ce1ea2b50 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -1,5 +1,10 @@
# LlamaIndex.TS
+[](https://www.npmjs.com/package/llamaindex)
+[](https://www.npmjs.com/package/llamaindex)
+[](https://www.npmjs.com/package/llamaindex)
+[](https://discord.com/invite/eN6D2HQ4aX)
+
LlamaIndex is a data framework for your LLM application.
Use your own data with large language models (LLMs, OpenAI ChatGPT and others) in Typescript and Javascript.
@@ -12,7 +17,7 @@ LlamaIndex.TS aims to be a lightweight, easy to use set of libraries to help you
## Getting started with an example:
-LlamaIndex.TS requries Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
+LlamaIndex.TS requires Node v18 or higher. You can download it from https://nodejs.org or use https://nvm.sh (our preferred option).
In a new folder:
@@ -84,11 +89,38 @@ Check out our NextJS playground at https://llama-playground.vercel.app/. The sou
- [SimplePrompt](/packages/core/src/Prompt.ts): A simple standardized function call definition that takes in inputs and formats them in a template literal. SimplePrompts can be specialized using currying and combined using other SimplePrompt functions.
+## Note: NextJS:
+
+If you're using NextJS App Router, you'll need to use the NodeJS runtime (default) and add the following config to your next.config.js to have it use imports/exports in the same way Node does.
+
+```js
+export const runtime = "nodejs"; // default
+```
+
+```js
+// next.config.js
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+ webpack: (config) => {
+ config.resolve.alias = {
+ ...config.resolve.alias,
+ sharp$: false,
+ "onnxruntime-node$": false,
+ mongodb$: false,
+ };
+ return config;
+ },
+};
+
+module.exports = nextConfig;
+```
+
## Supported LLMs:
- OpenAI GPT-3.5-turbo and GPT-4
- Anthropic Claude Instant and Claude 2
- Llama2 Chat LLMs (70B, 13B, and 7B parameters)
+- MistralAI Chat LLMs
## Contributing:
--
GitLab