docs: update README to include features section

xseman · Dec 22, 2024 · 5356107 · 5356107
1 parent 34968e0
commit 5356107
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,12 @@ sends logs to AWS [CloudWatch][aws_cloudwatch] using the AWS [v3 SDK][cloudwatch
 [cloudwatch_sdk]: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-logs/
 [log4js_github]: https://log4js-node.github.io/log4js-node/
 
+## Features
+
+- **Batching**: Send multiple log events in a single request to CloudWatch
+- **Buffering**: Send logs after a specified timeout, regardless of the batch size
+- **Log Group and Stream Creation**: Automatically create log groups and streams
+
 ## Overview
 
 <img src="docs/sequence.svg" alt="sequence" width="700px">