Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Animesh Rastogi committed Dec 27, 2024
1 parent e66a93a commit 5dad6a1
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 9 deletions.
24 changes: 23 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,26 @@ updates:
- "rastogiji"
commit-message:
prefix: "chore(deps)"
open-pull-requests-limit: 10
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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -36,7 +31,7 @@ MOCK_FILE_SEPARATOR="@@@@"
3. Start server:

```bash
npm start
pnpm start
```

## Environment Variables
Expand Down

0 comments on commit 5dad6a1

Please sign in to comment.