Add README.md

README.md

@@ -1,15 +1,40 @@
-# any-bot
+# Magical MailBox 🪄
 
-To install dependencies:
+A magic mailbox where people can deliver their mails to you anonymously. And you read them and answer . 😉 This mailbox also has some magical features. The sent letters can be edited or you can react to them. 🥰✨
 
-```bash
+**This mailbox does support:**
-bun install
+
+- 💬 Text
+- 🔉 Voice/Audio
+- 🎞 Video/Video note
+- 🎆 Sticker/Gif
+- 📁 Document
+- 🥰 Reactions
+
+## Commands
+
+| Command  | Description                     | Accessibility |
+| -------- | ------------------------------- | ------------- |
+| /start   | Show supported formats          | All users     |
+| /block   | Block a sender messages         | Admin         |
+| /unblock | Unblock blocked sender messages | Admin         |
+
+## Usage
+
+How to use it is simple. The senders just need to send their message like a normal message and the admin just needs to reply to the messages he receives to answer them. You can also use the command "/block" and "/unblock" when replying to a message.
+
+## Setup and deploy bot
+
+1.  Install [Bun](https://bun.sh)
+2.  Download latest version from [Releases](https://github.com/sudospaes/magical-mailbox/releases)
+3.  Extract downloaded zip
+4.  Move to extracted directory
+5.  Run `bun i` to install dependencies
+6.  Create `config.env` in the current directory and paste these in that
+
+```env
+token=your_telegram_bot_token
+admin=your_user_id // You can get it from @userinfobot
 ```
 
-To run:
+7. Run `bun start`
-
-```bash
-bun run index.ts
-```
-
-This project was created using `bun init` in bun v1.1.26. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

src/composer/commands.ts

@@ -8,7 +8,7 @@ const env = process.env;
 
 commands.command("start", (ctx) => {
   ctx.reply("Welcome to my magical mailbox 🪄");
-  ctx.reply(`My mailbox doese support:
+  ctx.reply(`My mailbox does support:
       💬 Text
       🔉 Voice/Audio
       🎞 Video/Video note