Skip to content
This repository has been archived by the owner on Aug 1, 2023. It is now read-only.

README: describe architecture and event timing #281

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

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, although the [GitHub Event API is delayed by five
minutes](https://github.blog/changelog/2018-08-01-new-delay-public-events-api/).

## Development

Source hosted at [GitHub](http://github.com/librariesio/firehose).
Expand Down