lxsameer
/
Orion
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the readme

This commit is contained in:
Sameer Rahmani 2022-04-18 19:10:26 +01:00
parent 1a940dc5d7
commit e763f730d2
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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=<ACTUAL_TOKEN_GOES_HERE>
```
and then you can run Orion via the builder script again with the
following command:
```bash