-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #110 from xmtp/update-name
Update README to reflect new repo name and contents
- Loading branch information
Showing
1 changed file
with
22 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,40 @@ | ||
|    | ||
|
|
||
| # 🤖 Bot Kit Pro 🤖 | ||
| # XMTP Node.js tools | ||
|
|
||
| Bot Kit Pro is a framework for running bots on the XMTP network designed for complex workflows that require high reliability. | ||
|
|
||
| ## Features | ||
| This repo provides a collection of tools for running high-quality XMTP bots in Node.js. It contains the following packages: | ||
|
|
||
| ### 📒 State Storage | ||
| - [Bot Kit Pro](./packages/bot-kit-pro/README.md) | ||
| - [GRPC API CLient](./packages/grpc-api-client/README.md) | ||
| - [Redis Persistence](./packages/redis-persistence/README.md) | ||
| - [Bot Examples](./packages/bot-examples/) | ||
| - [Bot Starter](./packages/bot-starter/) | ||
| - [CLI Starter](./packages/cli-starter/) | ||
|
|
||
| Every bot and conversation has a JSON state object that you can write to from inside your bot handler. Keep track of values between messages to build complex conversation workflows. | ||
| ## Bot Kit Pro | ||
|
|
||
| ### 💪 High Reliability | ||
| Bot Kit Pro is a framework for running bots on the XMTP network designed for complex workflows that require high reliability. | ||
|
|
||
| Bot Kit Pro connects to the XMTP network via GRPC for reliable, high performance, message streaming. Every message is stored in a database to ensure that messages are only processed once. If your bot is offline for a period of time it will fill in missing messages to ensure every message gets processed. You can also run multiple instances of your bot in parallel to allow for 0-downtime deploys. | ||
| ### 📒 State Storage | ||
|
|
||
| ### 🛢️ High Performance Conversation Store | ||
| Every bot and conversation has a JSON state object you can write to from inside your bot handler. Keep track of values between messages to build complex conversation workflows. | ||
|
|
||
| A common complaint from developers using XMTP to build bots is the high cost of running `client.conversations.list()` after restarting your application. We've added a database-backed cache to make sure your application only ever has to decrypt a conversation one time ever. | ||
| ### 💪 High reliability | ||
|
|
||
| ### 🔎 Designed For Auditability | ||
| Bot Kit Pro connects to the XMTP network via GRPC for reliable, high-performance message streaming. Every message is stored in a database to ensure that messages are processed only once. If your bot is offline for some time, it will fill in missing messages to ensure every message gets processed. You can also run multiple instances of your bot in parallel to allow for zero-downtime deploys. | ||
|
|
||
| No more poring over server logs. Because every incoming and outgoing message is stored in a database, you can build admin pages using tools like Retool to view the history of your bot's replies. | ||
| ### 🛢️ High-performance conversation store | ||
|
|
||
| ### 🧑🏻💻 CLI Starter | ||
| A common complaint from developers using XMTP to build bots is the high cost of running `client.conversations.list()` after restarting their apps. We added a database-backed cache so that apps need to decrypt a conversation only once. | ||
|
|
||
| Starter project for building an XMTP CLI. It provides a basic setup and examples to get started with building a command-line interface for XMTP. | ||
| ### 🔎 Designed For auditability | ||
|
|
||
| ### Bot Starter | ||
| No more poring over server logs. Because every incoming and outgoing message is stored in a database, you can build admin pages using tools like Retool to view the history of your bot's replies. | ||
|
|
||
| This repo makes it easier to create a bot on the XMTP network. It provides a basic setup and examples to get started with bot creation | ||
| ## 🧑🏻💻 CLI Starter | ||
|
|
||
| ## Packages | ||
| This package provides a starter project for building an XMTP CLI. It includes a basic setup and examples to get started with building a command-line interface for XMTP. | ||
|
|
||
| This repo contains the following packages | ||
| ## Bot Starter | ||
|
|
||
| - [Bot Kit Pro](./packages/bot-kit-pro/README.md) | ||
| - [GRPC API CLient](./packages/grpc-api-client/README.md) | ||
| - [Redis Persistence](./packages/redis-persistence/README.md) | ||
| - [Bot Examples](./packages/bot-examples/) | ||
| - [Bot Starter](./packages/bot-starter/) | ||
| - [CLI Starter](./packages/cli-starter/) | ||
| This package makes it easier to create a bot on the XMTP network. It provides a basic setup and examples to get started with bot creation. |