docs: Update README templates to include instructions for generating …

…embeddings
run-llama · Mar 20, 2024 · e851c0c · e851c0c
1 parent 58d9c0c
commit e851c0c
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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