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

Commit fab6d63

Browse files
committed
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.
1 parent ae17a50 commit fab6d63

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
Server sent event bridge for the [Libraries.io](https://libraries.io) events firehose.
44

5+
## Event timing
6+
7+
The Libraries.io events firehose allows you to consume new upstream release
8+
events in near-realtime.
9+
10+
The main [libraries.io dispatch
11+
application](https://libraries.io/github/librariesio/dispatch) polls several
12+
upstream repository feeds every 30 seconds. For GitHub specifically, the
13+
dispatch app watches the [server-sent event stream for
14+
GitHub](https://github.com/librariesio/github-firehose).
15+
16+
Your new release event should show up in the libraries.io firehose in less than
17+
one minute.
18+
519
## Development
620

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

0 commit comments

Comments
 (0)