search

bbc / sqs-consumer

Build Amazon Simple Queue Service (SQS) based applications without the boilerplate
https://bbc.github.io/sqs-consumer/
Other
1.72k stars 331 forks source link

Make API documentation easier to read #332

Closed nicholasgriffintn closed 1 year ago

nicholasgriffintn commented 1 year ago

The API documentation is a whole bunch of paragraphs that are hard to take in:

https://github.com/bbc/sqs-consumer#api

This should be updated to make it easier to read the documentation, potentially changing it to a table would be a good solution.