README.md

README.md

@@ -1,3 +1,59 @@
-### Lambda Utils
+# Lambda Utils
 
+Lambda Utils is a collection of utility modules designed to facilitate common tasks when developing AWS Lambda functions using Rust. These utilities are intended to simplify the development process and promote code reuse across different Lambda projects.
 
+## Included Utils
+
+### header.rs
+- **Description:** A utility module for parsing HTTP headers.
+- **Usage:** Helps in extracting and processing headers from incoming HTTP requests.
+
+### mongodb.rs
+- **Description:** A client helper module for MongoDB operations.
+- **Usage:** Facilitates interactions with MongoDB databases, providing an abstraction layer for common operations.
+
+### network.rs
+- **Description:** A utility module for obtaining network-related information.
+- **Usage:** Allows fetching the IP address of the Lambda function execution environment.
+
+### sqs.rs
+- **Description:** An AWS SQS (Simple Queue Service) helper module.
+- **Usage:** Simplifies interaction with SQS queues, including sending and receiving messages.
+
+## Getting Started
+To start using Lambda Utils in your AWS Rust Lambda projects, follow these steps:
+
+1. Add Lambda Utils as a dependency in your `Cargo.toml` file:
+
+    ```toml
+    [dependencies]
+    lambda-utils = "0.1.0"
+    ```
+
+2. Import the desired utility modules into your Rust Lambda project:
+
+    ```rust
+    // Example: Importing header.rs
+    extern crate lambda_utils;
+    use lambda_utils::header;
+    ```
+
+3. Begin using the utilities in your Lambda function code:
+
+    ```rust
+    // Example: Parsing HTTP headers
+    let user_agent = header::get_header_user_agent(request);
+    ```
+
+## Contributing
+Contributions to Lambda Utils are welcome! If you have suggestions for improvements or additional utility modules, please feel free to open an issue or submit a pull request on the [GitHub repository](https://github.com/MadeByAe/lambda-utils).
+
+## License
+This project is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute this code according to the terms of the license.
+
+## About
+Lambda Utils is maintained by (Ae) Angel Estrada. For questions or support, please contact [angel-estrada.com].
+
+---
+
+Made with ❤️ in San Francisco