WIP Fix documentation to refer to new package

scrive · Sep 17, 2024 · ff58286 · ff58286
1 parent 6be762f
commit ff58286
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/consumers/README.md b/consumers/README.md
@@ -0,0 +1,13 @@
+# consumers
+
+[![Hackage version](https://img.shields.io/hackage/v/consumers.svg?label=Hackage)](https://hackage.haskell.org/package/consumers)
+[![Build Status](https://github.com/well-typed/optics/workflows/Haskell-CI/badge.svg?branch=master)](https://github.com/scrive/consumers/actions?query=branch%3Amaster)
+
+Library for setting up concurrent consumers of data stored inside
+PostgreSQL database in a simple, declarative manner.
+
+See the `examples/` directory for a usage example.
+
+If you want to add metrics, see the
+[`consumers-metrics-prometheus`](https://hackage.haskell.org/package/consumers-metrics-prometheus)
+package to seamlessly instrument your consumer.
diff --git a/consumers/src/Database/PostgreSQL/Consumers/Components.hs b/consumers/src/Database/PostgreSQL/Consumers/Components.hs
@@ -32,6 +32,10 @@ import Log
 -- | Run the consumer. The purpose of the returned monadic action is to wait for
 -- currently processed jobs and clean up. This function is best used in
 -- conjunction with 'finalize' to seamlessly handle the finalization.
+--
+-- If you want to add metrics, see the
+-- [@consumers-metrics-prometheus@](https://hackage.haskell.org/package/consumers-metrics-prometheus)
+-- package to seamlessly instrument your consumer.
 runConsumer
   :: ( MonadBaseControl IO m
      , MonadLog m