chore: docs update (#14)

Because - docs update This commit - docs update
instill-ai · Sep 25, 2023 · dd13735 · dd13735
1 parent 30728a5
commit dd13735
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 0 deletions.
diff --git a/ReadMe.md b/ReadMe.md
@@ -21,6 +21,28 @@ import { Pipeline, listPipelinesQuery } from "@instill-ai/typescript-sdk";
 
 ```
 
+### config
+
+- `.env`
+```
+API_VERSION=v1alpha
+INSTILL_AI_USER_COOKIE_NAME=instill-ai-user
+APP_EDITION=local-ce:dev
+API_GATEWAY_URL=http://localhost:8080
+SELF_SIGNED_CERTIFICATION=false
+DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false
+LIST_PAGE_SIZE=6
+USAGE_COLLECTION_ENABLED=true
+SET_SECURE_COOKIE=false
+AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9
+APP_BASE_URL=http://localhost:3000
+MGMT_BACKEND_BASE_URL=http://localhost:8084
+PIPELINE_BACKEND_BASE_URL=http://localhost:8081
+CONNECTOR_BACKEND_BASE_URL=http://localhost:8082
+MODEL_BACKEND_BASE_URL=http://localhost:8083
+```
+
+
 
 ## API Reference
 

diff --git a/examples/next-app/README.md b/examples/next-app/README.md
@@ -16,6 +16,27 @@ pnpm add @instill-ai/typescript-sdk
 
 - make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp)
 - verify `.env`
+
+```
+API_VERSION=v1alpha
+INSTILL_AI_USER_COOKIE_NAME=instill-ai-user
+APP_EDITION=local-ce:dev
+API_GATEWAY_URL=http://localhost:8080
+SELF_SIGNED_CERTIFICATION=false
+DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false
+LIST_PAGE_SIZE=6
+USAGE_COLLECTION_ENABLED=true
+SET_SECURE_COOKIE=false
+AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9
+APP_BASE_URL=http://localhost:3000
+MGMT_BACKEND_BASE_URL=http://localhost:8084
+PIPELINE_BACKEND_BASE_URL=http://localhost:8081
+CONNECTOR_BACKEND_BASE_URL=http://localhost:8082
+MODEL_BACKEND_BASE_URL=http://localhost:8083
+```
+
+
+
 - see the changes done in `_document.tsx` and `next.env.mjs`
 
 ### Now You are ready.

diff --git a/examples/node-app/README.md b/examples/node-app/README.md
@@ -17,6 +17,24 @@ pnpm add @instill-ai/typescript-sdk
 - make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp)
 - verify `.env`
 
+```
+API_VERSION=v1alpha
+INSTILL_AI_USER_COOKIE_NAME=instill-ai-user
+APP_EDITION=local-ce:dev
+API_GATEWAY_URL=http://localhost:8080
+SELF_SIGNED_CERTIFICATION=false
+DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false
+LIST_PAGE_SIZE=6
+USAGE_COLLECTION_ENABLED=true
+SET_SECURE_COOKIE=false
+AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9
+APP_BASE_URL=http://localhost:3000
+MGMT_BACKEND_BASE_URL=http://localhost:8084
+PIPELINE_BACKEND_BASE_URL=http://localhost:8081
+CONNECTOR_BACKEND_BASE_URL=http://localhost:8082
+MODEL_BACKEND_BASE_URL=http://localhost:8083
+```
+
 ### Now You are ready.
 
 ```