dashbitco / broadway

Concurrent and multi-stage data ingestion and data processing with Elixir
https://elixir-broadway.org
Apache License 2.0
2.44k stars 161 forks source link

Add a list of common producers to the README #309

Closed whatyouhide closed 2 years ago

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build e4cdb7fe803437f68f5d6176b8a766c767e69a10-PR-309


Files with Coverage Reduction New Missed Lines %
lib/broadway/topology/producer_stage.ex 1 86.18%
<!-- Total: 1 -->
Totals Coverage Status
Change from base Build dbb50a92e567824314ff891c96c87d9c94d67c33: 0.2%
Covered Lines: 599
Relevant Lines: 637

💛 - Coveralls
josevalim commented 2 years ago

We moved those here: https://hexdocs.pm/broadway/introduction.html

Should we bring those sections as is to the README?

josevalim commented 2 years ago

Another option is to add a "See the docs for detailed how-tos and supported producers" to the end of the Introduction section linking to the page above.

whatyouhide commented 2 years ago

@josevalim I didn't know this was in the docs, nice. I pointed the README to the docs 🙃