From e763f730d2bf3f424a739a22ccbacd2d99f619fa Mon Sep 17 00:00:00 2001 From: Sameer Rahmani Date: Mon, 18 Apr 2022 19:10:26 +0100 Subject: [PATCH] Update the readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc982d3..71ecb95 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,19 @@ Orion is a telegram bot that converts voice messages into text and org-mode files. It can be trained for better accuracy. +## Requirements +You need to have Golang and Python installed. + +## Usage In order to use it, first you need to setup the project which you can just call -`./builder setup` and then you can run Orion via the builder script again with the +`./builder setup` . Also you need to store your bot's token (that you get from +Telegram's bot father) in the `.env` file like: + +``` +BOT_TOKEN= +``` + +and then you can run Orion via the builder script again with the following command: ```bash