Improve readme with project explanation and examples

[bonndan]

As far as I understand this library is to receive webhooks? Is Symfony a requirement or can it be used in any php project?

[tolry]

@bonndan git-webhooks is a standalone library, not tight to symfony, except that it currently uses a few symfony components and only works with a symfony request object (but there is already an open issue to change this to a psr-7 compliant object, #1).

A README update is definitely in order 😄 - but to give a short explanation here:

git-webhooks normalizes webhooks of different git collaboration platforms, currently only supporting github and gitlab (bitbucket support planned #2).

So, e.g. having a push event from github and gitlab will give you an identical Event value object.

I hope that made things clearer?

[bonndan]

Yes, thanks. If I integrate it into a legacy non-sf project every dependency comes out of the box with composer, right?

[DavidBadura]

yes, it is a library, not a symfony bundle 😉 the only dependency is symfony/http-foundation and it is in composer.json required.