Add notice about not using the factory pattern.

kreait · Dec 5, 2019 · bd90a20 · bd90a20
1 parent 3a9bf0f
commit bd90a20
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## Unreleased
+
+* Added a notice about not using the factory pattern described in the SDK documentation when using this package. 
+  (Although not a code change, adding it in the changelog to enhance visibility)
+
 ## 1.2.0 - 2019-10-26
 
 * Updated `kreait/firebase-php` to `^4.35.0`

diff --git a/README.md b/README.md
@@ -78,6 +78,9 @@ php artisan vendor:publish --provider="Kreait\Laravel\Firebase\ServiceProvider"
 Once you have retrieved a component, please refer to the [documentation of the Firebase PHP Admin SDK](https://firebase-php.readthedocs.io) 
 for further information on how to use it.
 
+**You don't need and should not use the `new Factory()` pattern described in the SDK documentation, this is already
+done for you with the Laravel Service Provider. Use Dependency Injection, the Facades or the `app()` helper instead**
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE) for more information.