From e851c0c834477ba49f85a5fdc85df03575394344 Mon Sep 17 00:00:00 2001 From: Marcus Schiesser Date: Wed, 20 Mar 2024 13:29:59 +0700 Subject: [PATCH] docs: Update README templates to include instructions for generating embeddings --- templates/types/simple/express/README-template.md | 8 +++++++- templates/types/streaming/express/README-template.md | 8 +++++++- templates/types/streaming/nextjs/README-template.md | 8 +++++++- 3 files changed, 21 insertions(+), 3 deletions(-) diff --git a/templates/types/simple/express/README-template.md b/templates/types/simple/express/README-template.md index 7ea94ab7..a596bc06 100644 --- a/templates/types/simple/express/README-template.md +++ b/templates/types/simple/express/README-template.md @@ -8,7 +8,13 @@ First, install the dependencies: npm install ``` -Second, run the development server: +Second, generate the embeddings of the documents in the `./data` directory (if this folder exists - otherwise, skip this step): + +``` +npm run generate +``` + +Third, run the development server: ``` npm run dev diff --git a/templates/types/streaming/express/README-template.md b/templates/types/streaming/express/README-template.md index 0e9d7961..452069d2 100644 --- a/templates/types/streaming/express/README-template.md +++ b/templates/types/streaming/express/README-template.md @@ -8,7 +8,13 @@ First, install the dependencies: npm install ``` -Second, run the development server: +Second, generate the embeddings of the documents in the `./data` directory (if this folder exists - otherwise, skip this step): + +``` +npm run generate +``` + +Third, run the development server: ``` npm run dev diff --git a/templates/types/streaming/nextjs/README-template.md b/templates/types/streaming/nextjs/README-template.md index 1509ded7..81b3b93f 100644 --- a/templates/types/streaming/nextjs/README-template.md +++ b/templates/types/streaming/nextjs/README-template.md @@ -8,7 +8,13 @@ First, install the dependencies: npm install ``` -Second, run the development server: +Second, generate the embeddings of the documents in the `./data` directory (if this folder exists - otherwise, skip this step): + +``` +npm run generate +``` + +Third, run the development server: ``` npm run dev