search

hotmeteor / receiver

Receiver is a drop-in webhook handling library for Laravel.
MIT License
384 stars 21 forks source link

Unclear documentation #9

Closed goodevilgenius closed 2 years ago

goodevilgenius commented 2 years ago

In you README, it states:

Simply implement the verify method in your provider and return true or false if it passes.

Likewise, it states:

To facilitate this, implement the handshake method in your provider

However, both of the examples for these two methods show them being on the controller, rather than the provider.

If both of these methods are on the controller, it doesn't make it possible to group the verification and handshake with the provider itself. In any case, the documentation is confusing.

hotmeteor commented 2 years ago

Feel free to create a PR that improves it if I don't get to it first!