Skip to content

Update README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RaymonDev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# StarBot
StarBot is a sample bot for Telegram which makes use of the GitHub API to fetch data. This project was written as part of [Google Code-in](https://codein.withgoogle.com/).

## Usage
### Usage
Message the bot with the name of a repository located under the user or organisation of the request URL. The bot will reply with the number of Stars held by that repository.

- You can use [BotFather](https://telegram.me/BotFather) to generate a token for Telegram.
- Place the token and GitHub request URL in a .env file. A sample is provided via `.env.sample`.
- Place the token and GitHub request URL in a .env file. A sample is provided via `.env.sample`.

### Requisites:
- Decouple python
```
pip install python-decouple
```
- Python Telegram Library (https://github.com/python-telegram-bot/python-telegram-bot)
```
pip install python-telegram-bot --upgrade
```