Skip to content

Commit

Permalink
feat: upgrade guide/docs (#95)
Browse files Browse the repository at this point in the history
* feat: upgrade guide/docs

* fix: remove travis

* fix: add view old version docs
  • Loading branch information
atymic authored Apr 21, 2020
1 parent 42b09f6 commit c6e8f01
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 24 deletions.
22 changes: 0 additions & 22 deletions .travis.yml

This file was deleted.

18 changes: 17 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

All notable changes to `twilio` will be documented in this file

## 1.0.0 - 2016-08-24
## 3.0.0

This is a major release with breaking changes. Please see the upgrading section in the readme for more info.

- Throw exceptions on send failure (with the ability to suppress certain error codes) **BREAKING CHANGE** [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
- Make service provider deferrable [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
- Drop support for Laravel 5.7 and lower **BREAKING CHANGE** [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
- Move config to a dedicated config file **BREAKING CHANGE** [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
- Update Twilio SDK to 6.x [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
- Add "Default To" local debugging support [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
- Switch to Github Actions CI [#91](https://github.com/laravel-notification-channels/twilio/pull/91)

## 2.0.0

- initial 2.x release

## 1.0.0

- initial release
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

This package makes it easy to send [Twilio notifications](https://documentation.twilio.com/docs) with Laravel 5.5+, 6.x and 7.x

You are viewing the `3.x` documentation. [Click here](https://github.com/laravel-notification-channels/twilio/tree/2.x) to view the `2.x` documentation.

## Contents

- [Installation](#installation)
Expand All @@ -31,7 +33,7 @@ You can install the package via composer:
composer require laravel-notification-channels/twilio
```

### Setting up your Twilio account
### Configuration

Add your Twilio Account SID, Auth Token, and From Number (optional) to your `.env`:

Expand Down Expand Up @@ -60,6 +62,21 @@ exception codes from [the documentation](https://www.twilio.com/docs/api/errors)
If you want to suppress all errors, you can set the option to `['*']`. The errors will not be logged but notification
failed events will still be emitted.

## Upgrading from 2.x to 3.x

If you're upgrading from version `2.x`, you'll need to make sure that your set environment variables match those above
in the config section. None of the environment variable names have changed, but if you used different keys in your
`services.php` config then you'll need to update them to match the above, or publish the config file and change the
`env` key.

You should also remove the old entry for `twilio` from your `services.php` config, since it's no longer used.

The main breaking change between `2.x` and `3.x` is that failed notification will now throw an exception unless they are
in the list of ignored error codes (publish the config file to edit these).

You can replicate the `2.x` behaviour by setting `'ignored_error_codes' => ['*']`, which will case all exceptions to be
suppressed.

## Usage

Now you can use the channel in your `via()` method inside the notification:
Expand Down Expand Up @@ -171,6 +188,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits

- [Gregorio Hernández Caso](https://github.com/gregoriohc)
- [atymic](https://github.com/atymic)
- [All Contributors](../../contributors)

## License
Expand Down

0 comments on commit c6e8f01

Please sign in to comment.