Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.

Commit c1f1449

Browse files
committed
Fix formatting, add alt tags to images
1 parent 4edd689 commit c1f1449

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@
44
</picture>
55

66
---
7-
[![CI](https://github.com/stacklok/codegate/actions/workflows/run-on-push.yml/badge.svg)](https://github.com/stacklok/codegate/actions/workflows/run-on-push.yml) | [![License: Apache 2.0](https://img.shields.io/badge/License-Apache2.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0) | [![](https://dcbadge.vercel.app/api/server/RkzVuTp3WK?logo=discord&label=Discord&color=5865&style=flat)](https://discord.gg/RkzVuTp3WK)
7+
8+
[![CI](https://github.com/stacklok/codegate/actions/workflows/run-on-push.yml/badge.svg)](https://github.com/stacklok/codegate/actions/workflows/run-on-push.yml)
9+
|
10+
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache2.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)
11+
|
12+
[![Discord](https://dcbadge.vercel.app/api/server/RkzVuTp3WK?logo=discord&label=Discord&color=5865&style=flat)](https://discord.gg/RkzVuTp3WK)
813

914
---
15+
1016
## Introduction
1117

12-
<img src="./assets/codegate.gif" style="width: 70%; height: 70%;" />
18+
<img src="./assets/codegate.gif" style="width: 70%; height: 70%;" alt="Animated gif of CodeGate detecting a malicious package in a Continue AI chat" />
1319

1420
CodeGate is a local gateway that makes AI coding assistants safer. CodeGate
1521
ensures AI-generated recommendations adhere to best practices, while
@@ -76,7 +82,6 @@ With Aider, you can choose from two leading AI model providers:
7682
- 💻 Local LLMs with [Ollama](https://ollama.com/)
7783
- 🧠 [OpenAI API](https://openai.com/api/)
7884

79-
8085
### Privacy first
8186

8287
Unlike E.T., your code never phones home! 🛸 CodeGate is designed with privacy
@@ -94,7 +99,6 @@ Check out the quickstart guides to get up and running quickly!
9499
- [Quickstart guide for GitHub Copilot with VS Code](https://docs.codegate.ai/quickstart)
95100
- [Quickstart guide for Continue with VS Code and Ollama](https://docs.codegate.ai/quickstart-continue)
96101

97-
98102
## 🎯 Usage
99103

100104
### IDE integration
@@ -139,19 +143,22 @@ pip install -e ".[dev]"
139143
### Testing
140144

141145
To run the unit tests, execute this command:
146+
142147
```bash
143148
pytest
144149
```
145150

146-
To run the integration tests, create a `.env` file in the repo root directory and add the
147-
following properties to it:
151+
To run the integration tests, create a `.env` file in the repo root directory
152+
and add the following properties to it:
153+
148154
```
149155
ENV_OPENAI_KEY=<YOUR_KEY>
150156
ENV_VLLM_KEY=<YOUR_KEY>
151157
ENV_ANTHROPIC_KEY=<YOUR_KEY>
152158
```
153159

154160
Then the integration tests can be executed by running:
161+
155162
```bash
156163
python tests/integration/integration_tests.py
157164
```

0 commit comments

Comments
 (0)