[Notifier] Streamline README files

This commit is contained in:
Oskar Stark 2020-12-08 13:11:16 +01:00
parent 25dc5ee6c4
commit dfddc899ce
10 changed files with 74 additions and 15 deletions

View File

@ -1,13 +1,12 @@
Firebase Notifier Firebase Notifier
================= =================
Provides Firebase integration for Symfony Notifier. Provides [Firebase](https://firebase.google.com) integration for Symfony Notifier.
DSN example DSN example
----------- -----------
``` ```
// .env file
FIREBASE_DSN=firebase://USERNAME:PASSWORD@default FIREBASE_DSN=firebase://USERNAME:PASSWORD@default
``` ```

View File

@ -1,7 +1,8 @@
Free Mobile Notifier Free Mobile Notifier
==================== ====================
Provides Free Mobile integration for Symfony Notifier. Provides [Free Mobile](https://mobile.free.fr) integration for Symfony Notifier.
This provider allows you to receive an SMS notification This provider allows you to receive an SMS notification
on your personal mobile number. on your personal mobile number.
@ -9,7 +10,6 @@ DSN example
----------- -----------
``` ```
// .env file
FREE_MOBILE_DSN=freemobile://LOGIN:PASSWORD@default?phone=PHONE FREE_MOBILE_DSN=freemobile://LOGIN:PASSWORD@default?phone=PHONE
``` ```

View File

@ -1,13 +1,12 @@
Mattermost Notifier Mattermost Notifier
=================== ===================
Provides Mattermost integration for Symfony Notifier. Provides [Mattermost](https://mattermost.com) integration for Symfony Notifier.
DSN example DSN example
----------- -----------
``` ```
// .env file
MATTERMOST_DSN=mattermost://ACCESS_TOKEN@default?channel=CHANNEL MATTERMOST_DSN=mattermost://ACCESS_TOKEN@default?channel=CHANNEL
``` ```

View File

@ -1,7 +1,19 @@
Nexmo Notifier Nexmo Notifier
============== ==============
Provides Nexmo integration for Symfony Notifier. Provides [Nexmo](https://nexmo.com) integration for Symfony Notifier.
DSN example
-----------
```
NEXMO_DSN=nexmo://KEY:SECRET@default?from=FROM
```
where:
- `KEY` is your Nexmo key
- `SECRET` is your Nexmo secret
- `FROM` is your sender
Resources Resources
--------- ---------

View File

@ -1,7 +1,20 @@
OvhCloud Notifier OvhCloud Notifier
================= =================
Provides OvhCloud integration for Symfony Notifier. Provides [OvhCloud](https://docs.ovh.com/gb/en/sms/) integration for Symfony Notifier.
DSN example
-----------
```
OVHCLOUD_DSN=ovhcloud://APPLICATION_KEY:APPLICATION_SECRET@default?consumer_key=CONSUMER_KEY&service_name=SERVICE_NAME
```
where:
- `APPLICATION_KEY` is your OvhCloud application key
- `APPLICATION_SECRET` is your OvhCloud application secret
- `CONSUMER_KEY` is your OvhCloud consumer key
- `SERVICE_NAME` is your OvhCloud service name
Resources Resources
--------- ---------

View File

@ -1,13 +1,12 @@
RocketChat Notifier RocketChat Notifier
=================== ===================
Provides RocketChat integration for Symfony Notifier. Provides [RocketChat](https://rocket.chat) integration for Symfony Notifier.
DSN example DSN example
----------- -----------
``` ```
// .env file
ROCKETCHAT_DSN=rocketchat://ACCESS_TOKEN@default?channel=CHANNEL ROCKETCHAT_DSN=rocketchat://ACCESS_TOKEN@default?channel=CHANNEL
``` ```

View File

@ -1,13 +1,12 @@
Sinch Notifier Sinch Notifier
============== ==============
Provides Sinch integration for Symfony Notifier. Provides [Sinch](https://www.sinch.com) integration for Symfony Notifier.
DSN example DSN example
----------- -----------
``` ```
// .env file
SINCH_DSN=sinch://SERVICE_PLAN_ID:AUTH_TOKEN@default?from=FROM SINCH_DSN=sinch://SERVICE_PLAN_ID:AUTH_TOKEN@default?from=FROM
``` ```

View File

@ -1,7 +1,22 @@
Slack Notifier Slack Notifier
============== ==============
Provides Slack integration for Symfony Notifier. Provides [Slack](https://slack.com) integration for Symfony Notifier.
DSN example
-----------
```
SLACK_DSN=slack://default/ID
```
where:
- `ID` is your webhook id (e.g. `/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX`)
in this case:
```
SLACK_DSN=slack://default/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
```
Resources Resources
--------- ---------

View File

@ -1,7 +1,18 @@
Telegram Notifier Telegram Notifier
================= =================
Provides Telegram integration for Symfony Notifier. Provides [Telegram](https://telegram.org) integration for Symfony Notifier.
DSN example
-----------
```
TELEGRAM_DSN=telegram://TOKEN@default?channel=CHAT_ID
```
where:
- `TOKEN` is your Telegram token
- `CHAT_ID` is your Telegram chat id
Resources Resources
--------- ---------

View File

@ -1,7 +1,19 @@
Twilio Notifier Twilio Notifier
=============== ===============
Provides Twilio integration for Symfony Notifier. Provides [Twilio](https://www.twilio.com) integration for Symfony Notifier.
DSN example
-----------
```
TWILIO_DSN=twilio://SID:TOKEN@default?from=FROM
```
where:
- `SID` is your Twillio ID
- `TOKEN` is your Twilio token
- `FROM` is your sender
Resources Resources
--------- ---------