-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a350288
commit c48b86e
Showing
1 changed file
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
# read-adviser-bot | ||
A Telegram Bot which consumes/stores/gives the pages for you to read | ||
|
||
To be done... | ||
|
||
--- | ||
### FAQ | ||
Available commands: | ||
- /start | ||
- /help | ||
- /rnd (pick a random link from the saved list) | ||
|
||
**Important:** | ||
Picking up links is a one-time action! | ||
If you make the Bot to pick any link for you, this link will be removed from the storage immediately. | ||
|
||
### Usage | ||
1. Get (or retrieve created) the Telegram Bot token value. | ||
2. Set it as an env variable called `TG_TOKEN`. | ||
3. In order to run the Telegram Bot service, just do the ```make start``` command in terminal | ||
|
||
Hint: the `make` builds the binary and runs the service whenever you invoke it, but you can also use a pre-built one [here](https://github.com/RSheremeta/read-adviser-bot/tags) |