diff --git a/README.md b/README.md index 99df345..57901a2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -

πŸ€– Telegram Bot Template

- - +# πŸ€– No Twitter Bot for [Lucid Creations Media The Cove](https://community.lucidcreations.media) Bot starter template based on [grammY](https://grammy.dev/) bot framework. -## Features +## Features of a grammY bot - Scalable structure - Config loading and validation @@ -23,13 +21,19 @@ Bot starter template based on [grammY](https://grammy.dev/) bot framework. - Runtimes: - [Bun](#bun-bunsh) +## Features of this bot + +- Obtain Group ID +- Delete Twitter/X links within whitelisted group +- Check if a group is in the whitelisted IDs + ## Usage Follow these steps to set up and run your bot using this template: 1. **Create a New Repository** - Start by creating a new repository using this template. You can do this by clicking [here](https://github.com/bot-base/telegram-bot-template/generate). + Start by creating a new repository using this template. You can do this by clicking [here](https://github.com/lucid-creations-media/no-twitter-bot/fork). 2. **Environment Variables Setup** @@ -45,7 +49,22 @@ Follow these steps to set up and run your bot using this template: Open the newly created `.env.bot.dev` and `.env.bot.prod` files and set the `BOT_TOKEN` environment variable. -3. **Launching the Bot** +3. **Remove references of LCM from your code.** + + Remove references of LCM from the following files: + + ``` + project-root/ + β”œβ”€β”€ src + β”‚ β”œβ”€β”€ bot # Code related to bot + β”‚ β”‚ β”œβ”€β”€ features # Bot features + β”‚ β”‚ β”‚ β”œβ”€β”€helpCommand.ts + β”‚ β”‚ β”‚ └──isLCMGroup.ts + β”‚ └── └── index.ts # Bot entry point + └── README.md + ``` + +4. **Launching the Bot** You can run your bot in both development and production modes. diff --git a/package.json b/package.json index 90bface..82404ca 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,14 @@ { - "name": "telegram-bot-template", + "name": "no-twitter-bot", "type": "module", - "version": "0.1.0", + "version": "1.0.1", "private": true, "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447", - "description": "Telegram bot starter template", + "description": "This grammY powered Telegram bot is designed to delete Twitter/X links and reformat services from whitelisted groups. This one is the main bot for the LCM Telegram groups/communities.", "imports": { "#root/*": "./build/src/*" }, - "author": "deptyped ", + "author": "Lucid Kobold (Lucid Creations Media) ", "license": "MIT", "engines": { "node": ">=20.0.0",