Skip to content

Commit c036d9c

Browse files
committed
fix: Update readme
1 parent a89a3a4 commit c036d9c

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ It is designed for anyone to clone or fork and use it as a starting point to bui
1010
- [Getting Started](#getting-started)
1111
- [Example](#example)
1212
- [Project Structure](#project-structure)
13+
- [Telegram Bot Commands](#telegram-bot-commands)
1314
- [Onboarding Modal Component](#onboarding-modal-component)
1415
- [Database](#database)
16+
- [Deployment](#deployment)
1517

1618
## Features
1719

@@ -175,6 +177,17 @@ Imagine that you want to send alerts to your users when their Aave positions are
175177

176178
In this case, you would add an `aave.ts` service to the **services** folder and a new `health.ts` job to the **jobs** folder that uses the Aave service to fetch user positions and build the message to be sent with the `MessageService.create` method, then instantiate them in the `index.ts` file.
177179

180+
## Telegram Bot Commands
181+
182+
The DMe framework includes a set of predefined commands that users can use to interact with the Telegram bot. These commands allow users to manage their subscriptions and get information about their linked wallets.
183+
184+
| Command | Description |
185+
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------|
186+
| `/start [address]` | Starts a conversation with the bot. If a wallet address is provided, it is linked to the user. |
187+
| `/add <address>` | Links an additional wallet address to the user's Telegram account. |
188+
| `/remove <index>` | Unlinks a wallet address from the user's Telegram account. The index is the number to the left of the address provided in `/list`. |
189+
| `/list` | Lists all wallet addresses linked to the user's Telegram account. |
190+
178191
## Onboarding Modal Component
179192

180193
The framework includes a React component that can be integrated into your React dApp to facilitate user onboarding. This component consists of a button that, when clicked, opens a modal dialog. The modal displays a QR code that the user can scan with their phone to easily start a conversation with the Telegram bot and link their wallet address for notifications in a single action. The modal also provides a link as an alternative to open Telegram directly in the browser.
@@ -234,3 +247,7 @@ DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
234247
Keep in mind that the migration files included with the framework are tailored for SQLite, so you may need to delete them and create new migrations for your chosen database.
235248

236249
For more details about supported databases and handling migrations, check the [Prisma documentation](https://www.prisma.io/docs/).
250+
251+
# Deployment
252+
253+
For production, do not use the `dev` script as it is intended for development purposes only. Instead, run `pnpm prisma migrate deploy` to apply migrations and, the run `pnpm build` followed by `pnpm start` to start the server.

0 commit comments

Comments
 (0)