From 2eff5f3f4e61224613be57ee3e6ddaa61c31da7b Mon Sep 17 00:00:00 2001 From: StNicolay Date: Tue, 23 Apr 2024 18:42:55 +0300 Subject: [PATCH] Updated README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9a3293b..f73e53d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # Pass Manager -Telegram bot that manages your passwords written in Rust +Telegram bot, written in Rust, that manages your passwords ## Usage -You can self host this bot you have to +This bot has to be self hosted. No official instance exists. To host this bot you have to: -* Add your telegram token into .env file +* Clone this repository - ```toml +* Create .env file in the root of the repository and add your token + + ```dotenv TOKEN= ``` -* Starting the bot using docker compose +* Start the bot using docker compose ```bash - sudo docker compose up -d + docker compose up -d ``` ## Cryptography @@ -41,3 +43,4 @@ These commands are supported: * /import — loads the accounts from a json file * /gen_password — generates 10 secure passwords * /cancel — cancels the current action +* /change_language - allows you to change the language