From fab6d63d229e0a4f67f588f4cb51c73c08065393 Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Fri, 8 Feb 2019 13:30:38 -0700 Subject: [PATCH] README: describe architecture and event timing Clarify to users how long they should expect to wait between pushing a new upstream release and seeing the event in the firehose. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 93d0ba8..3fd64eb 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ Server sent event bridge for the [Libraries.io](https://libraries.io) events firehose. +## Event timing + +The Libraries.io events firehose allows you to consume new upstream release +events in near-realtime. + +The main [libraries.io dispatch +application](https://libraries.io/github/librariesio/dispatch) polls several +upstream repository feeds every 30 seconds. For GitHub specifically, the +dispatch app watches the [server-sent event stream for +GitHub](https://github.com/librariesio/github-firehose). + +Your new release event should show up in the libraries.io firehose in less than +one minute. + ## Development Source hosted at [GitHub](http://github.com/librariesio/firehose).