Skip to content

Commit 464f70f

Browse files
authored
Merge pull request #76 from zackify/copilot/fix-75
Add Examples section to README with usage screenshots
2 parents e8ac2a5 + 5cd514f commit 464f70f

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# revect 🚀 ✨ 🧠
22

33
<!-- Demo video placeholder - Coming soon! -->
4-
<p align="center">🎬 Demo video coming soon! 🎬</p>
4+
<p align="center">🎬 Demo video coming soon! See <a href="#-examples">Examples</a> below for usage screenshots. 🎬</p>
55

66
[![Docker Pulls](https://img.shields.io/docker/pulls/zachrebuild/revect.io)](https://hub.docker.com/r/zachrebuild/revect.io)
77
[![GitHub Issues](https://img.shields.io/github/issues/zackify/revect)](https://github.com/zackify/revect/issues)
@@ -50,6 +50,7 @@ With MCP support, you can use revect as a private way to own your data and recal
5050
- [🔄 Switching Embedding Models](#-switching-embedding-models)
5151
- [☁️ Cloud Option](#️-cloud-option)
5252
- [🤝 Contributing](#-contributing)
53+
- [📖 Examples](#-examples)
5354

5455
If you wish to support the project or access your data across multiple devices, we recommend revect cloud (coming soon) ☁️.
5556
It's our hosted platform with additional features and seamless synchronization.
@@ -247,6 +248,28 @@ Coming soon! Our hosted platform will offer:
247248

248249
We'd love your help making revect even better! Check out our [issues page](https://github.com/zackify/revect/issues) to get started.
249250

251+
## 📖 Examples
252+
253+
Here are some visual examples of how to use revect with popular AI tools:
254+
255+
> **Privacy Note:** The Cline examples below demonstrate usage with devstral (Mistral's local AI model), showcasing fully private, end-to-end operation of revect without any external API calls.
256+
257+
### Adding the server to Cline (with devstral for fully private usage)
258+
259+
<img src="https://github.com/user-attachments/assets/c0c097b4-a386-4a6b-a4c6-5dbbbabbe084" alt="Adding revect server to Cline MCP configuration with devstral">
260+
261+
### Setting context on the fly in Cline (using devstral locally)
262+
263+
<img src="https://github.com/user-attachments/assets/ec7b3670-abb1-4291-8955-b2995bb1578a" alt="Setting context on the fly in Cline with devstral for private usage">
264+
265+
### Retrieving context information in Claude Desktop
266+
267+
<img src="https://github.com/user-attachments/assets/8a3cdb59-c4d3-4ca4-a668-f9c8821083f5" alt="Retrieving context information in Claude Desktop">
268+
269+
### Using context in Cline later on (fully private with devstral)
270+
271+
<img src="https://github.com/user-attachments/assets/3fb861b9-85d1-422c-a1cb-f44bc0e63180" alt="Using context in Cline later on with devstral for end-to-end privacy">
272+
250273
---
251274

252275
<p align="center">

0 commit comments

Comments
 (0)