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

Commit

Permalink
README: describe architecture and event timing
Browse files Browse the repository at this point in the history
Clarify to users how long they should expect to wait between pushing a
new upstream release and seeing the event in the firehose.
  • Loading branch information
ktdreyer committed Feb 8, 2019
1 parent ae17a50 commit fab6d63
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit fab6d63

Please sign in to comment.