search

tormjens / eventy

WordPress-like actions and filters for Laravel
422 stars 48 forks source link

Clarify the need to import the class or use the facade in readme #21

Closed philipnewcomer closed 5 years ago

philipnewcomer commented 5 years ago

The documentation is a bit confusing in that the examples can't be used as-is. You need to take the example and then either add a backslash to Eventy::{method} to use the Eventy facade, or import the Events facade as Eventy.

That may be obvious to a seasoned Laravel user, but it wasn't to me, so after I figured out what I was doing wrong, I updated the readme to make this a bit more clear. This should help to reduce issues like #15.

tormjens commented 5 years ago

@philipnewcomer How about if the facade itself was renamed to Eventy instead? To be honest it was named before the package itself, so I understand the confusion.

philipnewcomer commented 5 years ago

@tormjens yes, I think it would be least confusing for the facade to be named Eventy. I'm happy to provide another PR if you'd accept it.