diff --git a/README.md b/README.md index e22d4cb..8470e53 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ These scripts are not intended to be used for generic webhooks, but for those pr **Note**: Some specific parts of forgehook do not yet correspond to what you will find here. That's because I'm taking some time to step back and think about what's implemented so far and how it should end up, before i deepdive into the code again. The inconsistencies are marked with TODO notes. +# Current status + +As of April 28, the reference implementation for `forgehook-db` (databases/unix) works fine, so does `forgehook-notify` and the default `forgehook-trigger` (triggers/git-build). No endpoint is implemented yet. + # Introduction to webhooks Webhooks are simple web pings performed by a client to inform a server that something happened (push model). In the context of a [forge](https://en.wikipedia.org/wiki/Forge_(software)) (such as Gitea), a webhook additionally contains information as JSON payload about what changed on the repository, as well as an [HTTP signature](https://datatracker.ietf.org/doc/draft-ietf-httpbis-message-signatures/) in order to authenticate the client who sent the webhook via a shared secret.