From 5dad6a1afe88c4c261ddde2ada74de5deab3c4fc Mon Sep 17 00:00:00 2001
From: Animesh Rastogi <animesh.rastogi@konghq.com>
Date: Fri, 27 Dec 2024 18:05:17 +0530
Subject: [PATCH] Update docs

---
 .github/dependabot.yml                        | 24 ++++++++++++++++++-
 .github/workflows/{test.yml => run-tests.yml} |  2 ++
 README.md                                     | 11 +++------
 3 files changed, 28 insertions(+), 9 deletions(-)
 rename .github/workflows/{test.yml => run-tests.yml} (95%)

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index d6d43f5..2f61e2e 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -10,4 +10,26 @@ updates:
       - "rastogiji"
     commit-message:
       prefix: "chore(deps)"
-    open-pull-requests-limit: 10
\ No newline at end of file
+    open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    assignees:
+      - "rastogiji"
+    reviewers:
+      - "rastogiji"
+    commit-message:
+      prefix: "chore(deps)"
+    open-pull-requests-limit: 10
+  - package-ecosystem: docker
+    directory: /
+    schedule:
+      interval: weekly
+    assignees:
+      - "rastogiji"
+    reviewers:
+      - "rastogiji"
+    commit-message:
+      prefix: "chore(deps)"
+    open-pull-requests-limit: 10
diff --git a/.github/workflows/test.yml b/.github/workflows/run-tests.yml
similarity index 95%
rename from .github/workflows/test.yml
rename to .github/workflows/run-tests.yml
index 0e6dc62..5c6a425 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/run-tests.yml
@@ -30,6 +30,8 @@ jobs:
         node-version: [18.x, 20.x, 22.x]
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: pnpm/action-setup@v4
         with:
           version: 9
diff --git a/README.md b/README.md
index 0ec5874..f295508 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,7 @@ MockAI is a mock server for OpenAI's API. It allows you to simulate API response
 
 ## Features
 
-- Supports the following endpoints:
-
-  - `/v1/completions`
-  - `/v1/chat/completions`
-  - `/v1/images/generations`
-
+- Supports all the OpenAI (more providers coming soon) endpoints:
 - Allows you to specify the type of mock response: echo, random, or fixed.
 - Supports both single responses and streaming responses.
 - Reads random responses from a text file.
@@ -19,7 +14,7 @@ MockAI is a mock server for OpenAI's API. It allows you to simulate API response
 1. Install dependencies:
 
 ```bash
-npm install
+pnpm install
 ```
 
 2. Set env
@@ -36,7 +31,7 @@ MOCK_FILE_SEPARATOR="@@@@"
 3. Start server:
 
 ```bash
-npm start
+pnpm start
 ```
 
 ## Environment Variables