Skip to content

Commit ff64ab6

Browse files
committed
Update Installation and Pipelines section in README.md
1 parent 908f712 commit ff64ab6

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ config :flume,
113113
dequeue_lock_poll_interval: 500
114114
```
115115

116+
Import flume config in `config/config.exs` as given below:
117+
118+
```elixir
119+
...
120+
import_config "#{Mix.env()}.exs"
121+
+import_config "flume.exs"
122+
```
123+
116124
### Pipelines
117125

118126
Each pipeline is a GenStage pipeline having these parameters -
@@ -212,10 +220,11 @@ Flume supports rate-limiting for each configured pipeline.
212220

213221
Rate-Limiting has two key parameters -
214222

215-
* `rate_limit_scale` - Time scale in `milliseconds` for the pipeline
216-
* `rate_limit_count` - Total number of jobs to be processed within the time scale
217-
* `rate_limit_key`(optional) - Using this option, rate limit can be set across pipelines.
218-
When this option is not set, rate limit will be maintained for a pipeline.
223+
- `rate_limit_scale` - Time scale in `milliseconds` for the pipeline
224+
- `rate_limit_count` - Total number of jobs to be processed within the time scale
225+
- `rate_limit_key`(optional) - Using this option, rate limit can be set across pipelines.
226+
227+
       **Note**: When this option is not set, rate limit will be maintained for a pipeline.
219228

220229
```elixir
221230
rate_limit_count = 1000
@@ -262,7 +271,6 @@ Flume supports batch-processing for each configured pipeline.
262271
It groups individual jobs by the configured `batch_size` option and
263272
each worker process will receive a group of jobs.
264273

265-
266274
```elixir
267275
config :flume,
268276
pipelines: [

0 commit comments

Comments
 (0)