Skip to content

Commit 8d923e9

Browse files
chore: revise Blink description and add use cases (#222)
Co-authored-by: Matt Vollmer <matthewjvollmer@outlook.com>
1 parent 5cd29b9 commit 8d923e9

1 file changed

Lines changed: 17 additions & 8 deletions

File tree

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,28 @@
99
![NPM Version](https://img.shields.io/npm/v/blink)
1010
[![Documentation](https://img.shields.io/badge/documentation-blink.coder.com-blue)](https://blink.coder.com/docs)
1111

12-
Blink is a self-hosted platform for building and running custom, in-house AI agents. They respond via Slack, GitHub, and a browser-based UI. They are powerful chatbots that can search the web, run code in isolated environments, and securely access company data - all under your full control.
12+
Blink is a self-hosted platform for deploying custom AI agents. It ships with a built-in agent tooled for coding tasks and deep code research.
13+
Work alongside Blink agents in GitHub, the web UI, or in threaded Slack conversations.
14+
Tailor the included agent with new tools and prompts, or build new agents in TypeScript with the Blink SDK.
1315

1416
![Blink Demo](https://docs-resources.blink.so/blink-demo.gif)
1517

18+
## Use Cases
19+
20+
- **Understanding complex codebases** - ask questions about how a repo works, how parts connect, or where to start when the code is unfamiliar.
21+
- **Coding partner in Slack** - discuss ideas, open GitHub issues, or handle small coding tasks directly in Slack without breaking the conversation.
22+
- **Investigating GitHub issues** - have Blink gather context, reproduce issues, or summarize findings before opening or updating an issue.
23+
- **Customer support in shared channels** - let your customers ask technical questions in shared Slack channels and get answers backed by citations from your codebase and documentation.
24+
1625
## Features
1726

18-
- 🖥️ **Web UI** where you can chat with agents
19-
- 🛠️ **Blink SDK** - a set of libraries for building agents compatible with the Blink platform
20-
- ⚙️ **Blink CLI** - a command-line tool for developing agents locally
21-
- 🔍 **Observability** - use the web UI to view logs and traces
22-
- 📦 **Docker-based deployment** - agents are deployed as Docker containers
23-
- 🔒 **User and organization management** - invite your team to use and collaborate on agents
24-
- 🤖 **Pre-built, fully-functional [Scout agent](./packages/scout-agent/README.md)**, which you can customize for your own use
27+
- **Pre-built, fully-functional [Scout agent](./packages/scout-agent/README.md)**, which you can customize for your own use
28+
- **Web UI** where you can chat with agents
29+
- **Blink SDK** - a set of libraries for building agents compatible with the Blink platform
30+
- **Blink CLI** - a command-line tool for developing agents locally
31+
- **Observability** - use the web UI to view logs and traces
32+
- **Docker-based deployment** - agents are deployed as Docker containers
33+
- **User and organization management** - invite your team to use and collaborate on agents
2534

2635
## Get Started
2736

0 commit comments

Comments
 (0)