Skip to content

Commit 6861cb4

Browse files
authored
chore: tweak the readme structure (#260)
1 parent 8ce1ac0 commit 6861cb4

1 file changed

Lines changed: 23 additions & 21 deletions

File tree

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,40 @@ You can also build entirely new agents in TypeScript with the Blink SDK.
1515

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

18+
## Get Started
19+
20+
### Requirements
21+
22+
- Node.js 22+ or Bun
23+
- Docker (the server needs it to deploy agents)
24+
25+
### Install and run the Blink server
26+
27+
```sh
28+
npm install -g blink-server
29+
blink-server
30+
```
31+
32+
Open the Blink web UI in your browser and create your first agent. Alternatively, you may run the server [with Docker](https://blink.coder.com/docs/server/docker-deployment).
33+
1834
## Use Cases
1935

2036
- **Understanding complex codebases** - ask questions about how a repo works, how parts connect, or where to start when the code is unfamiliar.
2137
- **Coding partner in Slack** - discuss ideas, open GitHub issues, or handle small coding tasks directly in Slack without breaking the conversation.
2238
- **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.
2339

40+
- **And more** - Blink lets you build custom agents for any use case.
41+
2442
<p align="center">
2543
<img src="./scripts/blink-diagram.png" alt="Blink Diagram" width="600px">
2644
</p>
2745

28-
Many of the things you can do with Blink are also possible with ChatGPT, Claude Web, or Claude Code. Blink shines when you need to:
46+
## Why Blink?
2947

30-
- Retain control of your data and infrastructure. Blink runs on your own servers, and agents can use any LLM provider: be it Amazon Bedrock, Google Vertex, or a self-hosted model.
31-
- Centralize your conversations. Compared to Claude Code, all conversations are stored in a single database.
32-
- Centralize access. Blink lets you define access controls to your agents in a single place.
33-
- Fully control the source code of your agents. Blink is open source.
48+
- **Retain control of your data and infrastructure.** Blink runs on your own servers, and agents can use any LLM provider: be it Amazon Bedrock, Google Vertex, or a self-hosted model.
49+
- **Centralize your conversations.** Compared to Claude Code, all conversations are stored in a single database.
50+
- **Centralize access.** Blink lets you define access controls to your agents in a single place.
51+
- **Write code instead of configuring MCP and Skills.** With Blink you use TypeScript to build agents and add tools to them.
3452

3553
## Features
3654

@@ -42,22 +60,6 @@ Many of the things you can do with Blink are also possible with ChatGPT, Claude
4260
- **Docker-based deployment** - agents are deployed as Docker containers
4361
- **User and organization management** - invite your team to use and collaborate on agents
4462

45-
## Get Started
46-
47-
### Requirements
48-
49-
- Node.js 22+ or Bun
50-
- Docker (the server needs it to deploy agents)
51-
52-
### Install and run the Blink server
53-
54-
```sh
55-
npm install -g blink-server
56-
blink-server
57-
```
58-
59-
Open the Blink web UI in your browser and create your first agent. Alternatively, you may run the server [with Docker](https://blink.coder.com/docs/server/docker-deployment).
60-
6163
## What's a Blink agent?
6264

6365
Agents are HTTP servers that respond to events. The Blink Server deploys them as Docker containers, routes messages from Slack/GitHub/web UI, and manages conversation state - your agent just defines how to respond.

0 commit comments

Comments
 (0)