Skip to content

Commit

Permalink
docs: Add README.md files for various messaging platforms
Browse files Browse the repository at this point in the history
- Added README.md files for Chanify, DingTalk, Discord, Gitter, GoogleChat, IGot, Lark, Mattermost, MicrosoftTeams, NowPush, Ntfy, Push, Pushback, Pushover, Pushplus, QQ, RocketChat, ServerChan, ShowdocPush, Slack, Telegram, WeWork, XiZhi, YiFengChuanHua, Zulip
- Each README.md file contains a link to the respective platform's documentation
  • Loading branch information
guanguans committed Feb 27, 2024
1 parent 1d06211 commit 429b271
Show file tree
Hide file tree
Showing 25 changed files with 172 additions and 15 deletions.
7 changes: 7 additions & 0 deletions src/Chanify/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Chanify | [Home](./../../)

## [Usage example](./../../tests/Chanify/ClientTest.php)

## Related links

* [https://github.com/chanify/chanify-ios](https://github.com/chanify/chanify-ios)
7 changes: 7 additions & 0 deletions src/DingTalk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# DingTalk | [Home](./../../)

## [Usage example](./../../tests/DingTalk/ClientTest.php)

## Related links

* [https://developers.dingtalk.com/document/app/custom-robot-access](https://developers.dingtalk.com/document/app/custom-robot-access)
7 changes: 7 additions & 0 deletions src/Discord/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Discord | [Home](./../../)

## [Usage example](./../../tests/Discord/ClientTest.php)

## Related links

* [https://discord.com/developers/docs/resources/webhook#edit-webhook-message](https://discord.com/developers/docs/resources/webhook#edit-webhook-message)
7 changes: 7 additions & 0 deletions src/Gitter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Gitter | [Home](./../../)

## [Usage example](./../../tests/Gitter/ClientTest.php)

## Related links

* [https://developer.gitter.im/docs/messages-resource](https://developer.gitter.im/docs/messages-resource)
7 changes: 7 additions & 0 deletions src/GoogleChat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# GoogleChat | [Home](./../../)

## [Usage example](./../../tests/GoogleChat/ClientTest.php)

## Related links

* [https://developers.google.com/hangouts/chat/how-tos/webhooks](https://developers.google.com/hangouts/chat/how-tos/webhooks)
7 changes: 7 additions & 0 deletions src/IGot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# IGot | [Home](./../../)

## [Usage example](./../../tests/IGot/ClientTest.php)

## Related links

* [http://hellyw.com/#/](http://hellyw.com/#/)
7 changes: 7 additions & 0 deletions src/Lark/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Lark | [Home](./../../)

## [Usage example](./../../tests/Lark/ClientTest.php)

## Related links

* [https://www.feishu.cn/hc/zh-CN/articles/360024984973](https://www.feishu.cn/hc/zh-CN/articles/360024984973)
7 changes: 7 additions & 0 deletions src/Mattermost/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Mattermost | [Home](./../../)

## [Usage example](./../../tests/Mattermost/ClientTest.php)

## Related links

* [https://api.mattermost.com/l](https://api.mattermost.com/)
7 changes: 7 additions & 0 deletions src/MicrosoftTeams/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# MicrosoftTeams | [Home](./../../)

## [Usage example](./../../tests/MicrosoftTeams/ClientTest.php)

## Related links

* [https://www.microsoft.com/zh-cn/microsoft-teams/teams-for-work](https://www.microsoft.com/zh-cn/microsoft-teams/teams-for-work)
7 changes: 7 additions & 0 deletions src/NowPush/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# NowPush | [Home](./../../)

## [Usage example](./../../tests/NowPush/ClientTest.php)

## Related links

* [https://nowpush.io/api-docs/](https://nowpush.io/api-docs/)
7 changes: 7 additions & 0 deletions src/Ntfy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Ntfy | [Home](./../../)

## [Usage example](./../../tests/Ntfy/ClientTest.php)

## Related links

* [https://ntfy.sh/](https://ntfy.sh/)
7 changes: 7 additions & 0 deletions src/Push/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Push | [Home](./../../)

## [Usage example](./../../tests/Push/ClientTest.php)

## Related links

* [https://docs.push.techulus.com/api-documentation](https://docs.push.techulus.com/api-documentation)
7 changes: 7 additions & 0 deletions src/Pushback/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Pushback | [Home](./../../)

## [Usage example](./../../tests/Pushback/ClientTest.php)

## Related links

* [https://pushback.io/docs/getting-started](https://pushback.io/docs/getting-started)
7 changes: 7 additions & 0 deletions src/Pushover/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Pushover | [Home](./../../)

## [Usage example](./../../tests/Pushover/ClientTest.php)

## Related links

* [https://pushover.net/](https://pushover.net/)
7 changes: 7 additions & 0 deletions src/Pushplus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Pushplus | [Home](./../../)

## [Usage example](./../../tests/Pushplus/ClientTest.php)

## Related links

* [https://pushplus.hxtrip.com/index](https://pushplus.hxtrip.com/index)
7 changes: 7 additions & 0 deletions src/QQ/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# QQ | [Home](./../../)

## [Usage example](./../../tests/QQ/ClientTest.php)

## Related links

* [https://bot.q.qq.com/wiki/develop/api/openapi/message/post_messages.html](https://bot.q.qq.com/wiki/develop/api/openapi/message/post_messages.html)
7 changes: 7 additions & 0 deletions src/RocketChat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# RocketChat | [Home](./../../)

## [Usage example](./../../tests/RocketChat/ClientTest.php)

## Related links

* [https://docs.rocket.chat/guides/administration/admin-panel/integrations](https://docs.rocket.chat/guides/administration/admin-panel/integrations)
7 changes: 7 additions & 0 deletions src/ServerChan/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ServerChan | [Home](./../../)

## [Usage example](./../../tests/ServerChan/ClientTest.php)

## Related links

* [https://sct.ftqq.com/](https://sct.ftqq.com/)
7 changes: 7 additions & 0 deletions src/ShowdocPush/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ShowdocPush | [Home](./../../)

## [Usage example](./../../tests/ShowdocPush/ClientTest.php)

## Related links

* [https://push.showdoc.com.cn/#/](https://push.showdoc.com.cn/#/)
7 changes: 7 additions & 0 deletions src/Slack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Slack | [Home](./../../)

## [Usage example](./../../tests/Slack/ClientTest.php)

## Related links

* [https://api.slack.com/messaging/webhooks](https://api.slack.com/messaging/webhooks)
7 changes: 7 additions & 0 deletions src/Telegram/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Telegram | [Home](./../../)

## [Usage example](./../../tests/Telegram/ClientTest.php)

## Related links

* [https://core.telegram.org/bots/api#sendmessage](https://core.telegram.org/bots/api#sendmessage)
7 changes: 7 additions & 0 deletions src/WeWork/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# WeWork | [Home](./../../)

## [Usage example](./../../tests/WeWork/ClientTest.php)

## Related links

* [https://open.work.weixin.qq.com/api/doc/90000/90136/91770](https://open.work.weixin.qq.com/api/doc/90000/90136/91770)
19 changes: 4 additions & 15 deletions src/XiZhi/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
# XiZhi
# XiZhi | [Home](./../../)

## Usage
## [Usage example](./../../tests/XiZhi/ClientTest.php)

```php
$authenticator = new Guanguans\Notify\XiZhi\Authenticator('XZd60aea56567ae39a1b1920cbc42bb5bd');
$client = new Guanguans\Notify\XiZhi\Client($authenticator);
## Related links

$response = $client->send(Guanguans\Notify\XiZhi\Messages\SingleMessage::make([
'title' => 'This is title.',
'content' => 'This is content.',
]));

$response = $client->send(Guanguans\Notify\XiZhi\Messages\ChannelMessage::make([
'title' => 'This is title.',
'content' => 'This is content.',
]));
```
* [https://xz.qqoq.net/#/index](https://xz.qqoq.net/#/index)
7 changes: 7 additions & 0 deletions src/YiFengChuanHua/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# YiFengChuanHua | [Home](./../../)

## [Usage example](./../../tests/YiFengChuanHua/ClientTest.php)

## Related links

* [https://www.phprm.com/push/h5/](https://www.phprm.com/push/h5/)
7 changes: 7 additions & 0 deletions src/Zulip/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Zulip | [Home](./../../)

## [Usage example](./../../tests/Zulip/ClientTest.php)

## Related links

* [https://zulip.com/api/send-message](https://zulip.com/api/send-message)

0 comments on commit 429b271

Please sign in to comment.