doc(readme): styling

This commit is contained in:
Udit Karode 2023-04-14 15:58:30 +05:30 committed by GitHub
parent bc1f2901ba
commit 0c8f6b768e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,20 +5,20 @@ A Telegram bot that lets you interact with the Bing AI from chats that you allow
**> To start using this project,** **> To start using this project,**
- Git clone and cd into cloned dir - Git clone and cd into cloned dir
- Run `yarn install` to install the dependencies. - Run `yarn install` to install the dependencies.
- Create a `.env` file or set environment variables according to the reference file `.env.example` - Create a `.env` file or set environment variables according to the reference file [.env.example](https://github.com/uditkarode/bing-chat-telegram/blob/master/.env.example)
- Run `yarn dev` or `yarn build && yarn start` to start the bot. - Run `yarn dev` or `yarn build && yarn start` to start the bot.
**> To start using this project using Docker,** **> To start using this project using Docker,**
- Git clone and cd into cloned dir ###### >> on dev
- Run `docker compose -f .build/docker-compose.yml build` to build the container. - Git clone and cd into cloned dir
- Create a `.env` file or set environment variables according to the reference file `.env.example` - Run `docker compose -f .build/docker-compose.yml build` to build the container.
- Run `docker compose up -d` to start the bot. - Create a `.env` file or set environment variables according to the reference file `.env.example`
- Run `docker compose -f .build/docker-compose.yml push` to push container to registry. - Run `docker compose up -d` to start the bot.
- Run `docker compose -f .build/docker-compose.yml push` to push container to registry.
**> To start using this project using Docker in prod,** ###### >> on prod
- Create `docker-compose.yml` with the content from `docker-compose.yml` in repo. - Create `docker-compose.yml` with the content from `docker-compose.yml` in repo.
- Create `.env` with the required variables. (see .env.example in repo) - Create `.env` with the required variables (see [.env.example](https://github.com/uditkarode/bing-chat-telegram/blob/master/.env.example)).
- Run `docker compose up -d` to start the bot. - Run `docker compose up -d` to start the bot.
**> To enable Telegram command autocompletion,** **> To enable Telegram command autocompletion,**