From 00006956e23b4897cec3fc8a1c5bbd4d8f5290d1 Mon Sep 17 00:00:00 2001 From: Udit Karode Date: Sun, 9 Apr 2023 19:25:14 +0530 Subject: [PATCH] doc(readme): use env vars for setup --- .env.example | 6 +++--- README.md | 16 +++++++++------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/.env.example b/.env.example index 98702f0..13bc647 100644 --- a/.env.example +++ b/.env.example @@ -3,9 +3,9 @@ # access to Bing Chat! BING_COOKIE= -# The bot token you obtained from BotFather +# The bot token you obtained from BotFather. TG_TOKEN= -# A comma separated list of chat IDs you want to allow -# to allow usage in all chats, set this to "all" +# A comma separated list of chat IDs you want to allow. +# To allow usage in all chats, set this to "all". ALLOWED_CHATS= diff --git a/README.md b/README.md index 40f2fd7..ab7f57a 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,20 @@ A Telegram bot that lets you interact with the Bing AI from chats that you allow **> To start using this project,** -* Run `yarn install` to install the dependencies. -* Copy `variables.example.ts` to `variables.ts`, go through it, and add the required information. -* Run `yarn dev` or `yarn build && yarn start` to start the bot. +- Run `yarn install` to install the dependencies. +- Create a `.env` file or set environment variables according to the reference file `.env.example` +- Run `yarn dev` or `yarn build && yarn start` to start the bot. **> To start using this project using Docker,** -* Run `docker compose -f .build/docker-compose.yml build` to build the container -* Copy `variables.example.ts` to `variables.ts`, go through it, and add the required information. -* Run `docker compose up -d` to start the bot. +- Run `docker compose -f .build/docker-compose.yml build` to build the container +- TODO +- Run `docker compose up -d` to start the bot. **> To enable Telegram command autocompletion,** -* Press the `Edit Commands` button in your bot's menu on BotFather, and paste the following: + +- Press the `Edit Commands` button in your bot's menu on BotFather, and paste the following: + ``` ai - send a prompt to the AI variant - get or set the variant of the chat