chore: adding a link to the documentation (#471)

bbc · Mar 11, 2024 · bd7fbbb · bd7fbbb
1 parent b554da6
commit bd7fbbb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,10 @@ npm install sqs-consumer
 
 We will only support Node versions that are actively or security supported by the Node team. If you are still using an Node 14, please use a version of this library before the v7 release, if you are using Node 16, please use a version before the v7.3.0 release.
 
+## Documentation
+
+Visit [https://bbc.github.io/sqs-consumer/](https://bbc.github.io/sqs-consumer/) for the full API documentation.
+
 ## Usage
 
 ```js