docs: update README to include instructions for cloning individual ex… (

#41)
tidbcloud · Jan 13, 2025 · 92dcf59 · 92dcf59
1 parent 8f70c45
commit 92dcf59
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,24 @@ pnpm install
 
 3. Each example has its own environment variables that need to be configured. Check the README in each example directory for specific setup instructions.
 
+4. If you only want to clone a single example, you can use the following command:
+
+```bash
+npx degit tidbcloud/examples-projects/examples/with-chat2query-api my-example
+```
+
+Then cd into that example directory and run `pnpm install`.
+
+You can also replace **with-chat2query-api** with the name of the example you want to clone, for example:
+
+```bash
+npx degit tidbcloud/examples-projects/examples/with-data-api my-example
+npx degit tidbcloud/examples-projects/examples/with-nextjs-todo my-example
+npx degit tidbcloud/examples-projects/examples/with-vector-search my-example
+```
+
+Each project requires a `.env` file to be created in the root of the example directory. You can refer to the README in each example directory for more details.
+
 ## Examples
 
 ### Next.js Todo App

diff --git a/examples/with-chat2query-api/package.json b/examples/with-chat2query-api/package.json
@@ -17,7 +17,7 @@
     "@trpc/server": "11.0.0-rc.660",
     "clsx": "2.1.1",
     "framer-motion": "11.15.0",
-    "next": "15.1.0",
+    "next": "15.1.4",
     "prism-react-renderer": "2.4.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",

diff --git a/examples/with-data-api/package.json b/examples/with-data-api/package.json
@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "chart.js": "^4.4.7",
-    "next": "15.1.0",
+    "next": "15.1.4",
     "react": "18.3.1",
     "react-chartjs-2": "^5.2.0",
     "react-dom": "18.3.1",

diff --git a/examples/with-nextjs-todo/package.json b/examples/with-nextjs-todo/package.json
@@ -18,7 +18,7 @@
     "@trpc/server": "11.0.0-rc.660",
     "clsx": "2.1.1",
     "drizzle-orm": "0.38.2",
-    "next": "15.1.0",
+    "next": "15.1.4",
     "nuqs": "2.2.3",
     "react": "18.3.1",
     "react-dom": "18.3.1",

diff --git a/examples/with-vector-search/package.json b/examples/with-vector-search/package.json
@@ -17,7 +17,7 @@
     "@trpc/server": "11.0.0-rc.660",
     "ai": "4.0.18",
     "clsx": "2.1.1",
-    "next": "15.1.0",
+    "next": "15.1.4",
     "ollama-ai-provider": "0.16.0",
     "prism-react-renderer": "2.4.0",
     "react": "18.3.1",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml