Skip to content

Commit e073b1c

Browse files
committed
update docblock and readme
1 parent f40c6b5 commit e073b1c

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ and manage customization through messages and buttons on Telegram.
1111

1212
![License](https://img.shields.io/github/license/cslant/telegram-git-notifier-app.svg?style=flat-square)
1313
[![Latest Version](https://img.shields.io/github/release/cslant/telegram-git-notifier-app.svg?style=flat-square)](https://github.com/cslant/telegram-git-notifier-app/releases)
14+
![Test Status](https://img.shields.io/github/actions/workflow/status/cslant/telegram-git-notifier-app/setup_test.yml?label=tests&branch=main)
15+
![Code Style Status](https://img.shields.io/github/actions/workflow/status/cslant/telegram-git-notifier-app/php-cs-fixer.yml?label=code%20style&branch=main)
1416
[![StyleCI](https://styleci.io/repos/656960426/shield)](https://styleci.io/repos/656960426)
1517
[![Quality Score](https://img.shields.io/scrutinizer/g/cslant/telegram-git-notifier-app.svg?style=flat-square)](https://scrutinizer-ci.com/g/cslant/telegram-git-notifier-app)
1618
[![Maintainability](https://api.codeclimate.com/v1/badges/7ccaccebe9cd58ff3df5/maintainability)](https://codeclimate.com/github/cslant/telegram-git-notifier-app/maintainability)
@@ -131,7 +133,7 @@ TGN_APP_URL=https://123456789.ngrok.io
131133

132134
1. Open a chat with your bot.
133135
2. Send any message to your bot. (This handle needs to get your chat ID)
134-
3. Go to the following URL: `<TGN_APP_URL>/webhook/getUpdate.php`
136+
3. Go to the following URL: `<TGN_APP_URL>/webhooks/getUpdate.php`
135137
4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID.
136138
5. Paste the Chat ID in your `.env` file.
137139

@@ -240,7 +242,7 @@ TGN_APP_URL=https://123456789.ngrok-free.app
240242

241243
1. Open a chat with your bot.
242244
2. Send any message to your bot. (This handle needs to get your chat ID)
243-
3. Go to the following URL: `<TGN_APP_URL>/webhook/getUpdate.php`
245+
3. Go to the following URL: `<TGN_APP_URL>/webhooks/getUpdate.php`
244246
4. Look for the `"chat":{"id":` field and copy the number after it. This is your Chat ID.
245247
5. Paste the Chat ID in your `.env` file.
246248

@@ -261,7 +263,7 @@ After setting up your domain and SSL certificate, you need to set up the webhook
261263
**Go to:**
262264

263265
```text
264-
<APP_URL>/webhook/set.php
266+
<APP_URL>/webhooks/set.php
265267
```
266268

267269
> **Note:** Replace `<APP_URL>` with your app URL in .env file.

src/Http/Actions/WebhookAction.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,32 @@ public function __construct()
2121
/**
2222
* Set webhook for telegram bot
2323
*
24-
* @return false|string
24+
* @return string
2525
* @throws WebhookException
2626
*/
27-
public function set(): false|string
27+
public function set(): string
2828
{
2929
return $this->webhook->setWebhook();
3030
}
3131

3232
/**
3333
* Delete webhook for telegram bot
3434
*
35-
* @return false|string
35+
* @return string
3636
* @throws WebhookException
3737
*/
38-
public function delete(): false|string
38+
public function delete(): string
3939
{
4040
return $this->webhook->deleteWebHook();
4141
}
4242

4343
/**
4444
* Get webhook update
4545
*
46-
* @return false|string
46+
* @return string
4747
* @throws WebhookException
4848
*/
49-
public function getUpdates(): false|string
49+
public function getUpdates(): string
5050
{
5151
return $this->webhook->getUpdates();
5252
}

0 commit comments

Comments
 (0)