Skip to content

Commit 82e8094

Browse files
authored
Update README (#5)
1 parent 0f8f919 commit 82e8094

File tree

1 file changed

+50
-40
lines changed

1 file changed

+50
-40
lines changed

README.md

Lines changed: 50 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -9,69 +9,88 @@
99
[![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder)
1010
![NPM Version](https://img.shields.io/npm/v/blink)
1111

12-
Blink is a tool for building and sharing AI agents.
12+
## Blink Overview
1313

14-
- Leverages the familiar [AI SDK](https://github.com/vercel/ai) at it's core.
15-
- Built-in tools for making Slack, GitHub, and Discord bots.
16-
- Every agent is simply a Node HTTP server - no cloud required.
14+
Blink is an MIT-licensed agent development engine that provides a complete foundation for building, deploying, and scaling AI agents as code. We believe language models are the core of the experience, and Blink gives you the freedom to use them to their full potential.
15+
16+
Bring your own LLM keys to build and run Blink agents locally. Deployment to Blink Cloud will never be required. You can develop, test, and run agents entirely on your own machine without even creating a Blink Cloud account.
17+
18+
- **Blink agents are Node.js servers** written in TypeScript that handle chat messages, webhooks, and API requests over HTTP.
19+
- **Blink comes with comprehensive SDKs** that give you the ability to deploy agents to Slack and GitHub with ease
20+
- **The platform handles all the infrastructure** complexity with serverless deployment, logging, and scaling, so you can focus on building
21+
- **Full portability between local development and production** with identical behavior across environments
22+
- **Use the popular Vercel AI SDK** with support for multiple LLM providers and streaming responses
1723

1824
## Getting Started
1925

20-
Install the `blink` package with your favorite package manager:
26+
Creating your first agent or Slackbot is quick with the Blink CLI. You can build, test, and start chatting with your agent in Slack in just a few minutes, right from your terminal.
27+
28+
https://github.com/user-attachments/assets/6bb73e58-b4ae-4543-b2c0-0e1195113ba6
29+
30+
### Use your favorite package manager to globally install `blink`:
2131

2232
```sh
2333
bun i -g blink
2434
```
35+
```sh
36+
npm i -g blink
37+
```
38+
```sh
39+
pnpm add -g blink
40+
```
41+
```sh
42+
yarn global add blink
43+
```
2544

26-
Create an agent:
45+
### Create an agent:
2746

2847
```sh
2948
mkdir my-agent
3049
cd my-agent
3150
blink init
3251
```
3352

34-
Start development mode:
35-
3653
> [!NOTE]
37-
> You'll need to provide your own API keys to use language models. Put them in `.env.local` and the dev server will automatically load them.
54+
> You'll need to provide your own LLM API keys. Add them during `blink init` or add them later to `.env.local` and the dev server will automatically load them.
55+
56+
### Start development mode:
3857

3958
```sh
4059
blink dev
4160
```
4261

43-
You can now edit `src/agent.ts` and the dev server will hot-reload your agent.
62+
You can now edit `agent.ts` in your editor or by using [Edit Mode](https://docs.blink.so/get-started/building-with-blink) in your terminal and the dev server will hot-reload your agent.
4463

45-
Bundle your agent as a Node package to share it with others:
64+
### Deploy your agent to [Blink Cloud](https://blink.so):
4665

4766
```sh
48-
blink build
49-
npm publish
67+
blink deploy
5068
```
69+
> [!IMPORTANT]
70+
> [Blink Cloud](https://blink.so) is not required to build Blink agents.
71+
> We guarantee that Blink agents will always be local-first.
5172
52-
Optionally, deploy your agent to [blink.so](https://blink.so):
73+
## Building with Edit and Run Modes
5374

54-
> [!NOTE]
55-
> [blink.so](https://blink.so) is not required to use Blink.
56-
> We [guarantee](#why-blink) that Blink agents will always be local-first.
75+
After running `bun i -g blink` to globally install Blink, run `blink init` to scaffold your new agent.
5776

58-
```sh
59-
blink deploy
60-
```
77+
https://github.com/user-attachments/assets/683e4554-55fd-4240-916d-a496da7e63d2
78+
79+
Giving your new agents tools and personality is as easy as switching to [Edit Mode](https://docs.blink.so/get-started/building-with-blink) `(CTRL+T)` and describing what you want your agent to do.
80+
81+
Edit Mode is specifically trained to build your agent and understand the full context of both Edit Mode and Run Mode chats. This is a key capability that makes Edit Mode the essential building and debugging partner.
6182

62-
## Building Your First Agent
83+
> [!NOTE]
84+
> Run Mode can only read its own context to preserve a real-world user experience while testing in your terminal.
85+
86+
https://github.com/user-attachments/assets/4abd47ad-4b59-41d5-abda-27ed902ae69b
6387

64-
Here are some examples of agents commonly built with Blink:
6588

66-
- [Coding Agent](./examples/coding-agent) with tools and context specific to your codebase.
67-
- [Customer Support Agent](./examples/customer-support-agent) directed to understand your product and documentation.
68-
- [Slack Bot](./examples/slack-bot) with information relevant to your company.
69-
- [GitHub Bot](./examples/github-bot) with custom tools to interact with your repositories.
70-
- [Everything Agent](./examples/everything-agent) that does all of the above to show the full power of Blink.
89+
## How Blink Agents Work
7190

72-
## Developing an Agent
91+
Building agents in Run Mode lifts most of the burden of coding new agents. However, here's a breakdown of how Blink agents work under the hood.
7392

74-
Blink has built-in APIs for managing [chats](#chats), [storage](#storage), and [tools](#tools).
93+
Blink has built-in APIs for managing chats, storage, and tools.
7594

7695
### Chats
7796

@@ -354,16 +373,7 @@ By default, Blink uses [esbuild](https://esbuild.github.io/) to bundle your agen
354373

355374
The `build` function can be customized to use a different bundler if you wish.
356375

357-
## Why Blink?
358-
359-
Blink is a tool for building AI agents, not a framework. It's simple at it's core. Every agent is an HTTP server that follows a [basic protocol](#).
360-
361-
You provide the tools, and Blink handles the rest. We believe that the language models are the most important part of the equation, and we allow you to leverage the full power of them.
362-
363-
Blink will never require the cloud to run agents. Blink is MIT licensed - you don't have to trust us.
364-
365-
## Cloud
366376

367-
`blink deploy` runs your agent in the cloud at [blink.so](https://blink.so).
377+
## Blink Documentation
368378

369-
This allows you to share your agent with others, and to access it from anywhere.
379+
For a closer look at Blink, visit [docs.blink.so](https://docs.blink.so/).

0 commit comments

Comments
 (0)