Update changelog & readme

SammyK · Jul 22, 2017 · e2c2b42 · e2c2b42
1 parent 8652e1c
commit e2c2b42
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - Added support for auto-discovery in Laravel 5.5 (#184)
 - Allowed more versions of PHPUnit to be used (#183)
+- Make publishing the config file optional (#182)
 - Removed PHP 5.5 (EOL) from tested versions in Travis CI
 - Bumped the Graph API version in the config to [v2.10](https://developers.facebook.com/docs/apps/changelog)
 

diff --git a/README.md b/README.md
@@ -124,6 +124,10 @@ Route::get('/facebook/login', function(SammyK\LaravelFacebookSdk\LaravelFacebook
 
 ### Configuration File
 
+> **Note:** As of version **3.4.0**, publishing the config file is optional as long as you set your [required config values](#required-config-values).
+
+> **Also note:** The config file contains a default Graph API version that gets bumped up to the latest stable version periodically which might cause a breaking change when you update this package in a minor or patch version. It is recommended that you still publish the config file and update the Graph API version on your own time to prevent breaking things.
+
 After [creating an app in Facebook](https://developers.facebook.com/apps), you'll need to provide the app ID and secret. In Laravel you can publish the configuration file with `artisan`.
 
 ```bash