Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mattiamalonni authored Jul 16, 2019
1 parent fbaa9d9 commit 98914c5
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,23 @@ Send notifications to Telegram about Capistrano deployments.
$ bundle
```

3. Require the library in your application's Capfile:
3. Require the library in your application's `Capfile`:

```ruby
require 'capistrano/telegram'
```

## Prerequisites
1. Create a new bot (refer to the official Telegram guide [here](https://core.telegram.org/bots)) and take note of the token generated.

2. Include your bot in the desired chat

3. To get the `chat_id`, go to: ht<span>tps://</span>api.telegram.org/bot**YOUR_BOT_TOKEN**/getUpdates


## Configuration

1. Add these lines to your `config/deploy.rb` file:
1. Add these lines to your application's `config/deploy.rb` file:

```ruby
set :telegram_bot_key, 'YOUR_BOT_ID'
Expand Down

0 comments on commit 98914c5

Please sign in to comment.