Merge pull request #3 from Evernorth/feature/docs-update

documentation updates
Evernorth · Oct 24, 2024 · f0ca39e · f0ca39e
2 parents 68744b1 + b9aa098
commit f0ca39e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,10 @@ All notable changes to this project will be documented in this file.
 We follow the [Semantic Versioning 2.0.0](http://semver.org/) format.
 
 
-## 1.0.0-2024-10-02
+## v1.0.1 2024-10-24
+Updated documentation
+
+## v1.0.0 2024-10-02
 
 Initial Release
 

diff --git a/README.md b/README.md
@@ -1,8 +1,15 @@
 # aws-lambda-go-adapter
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/Evernorth/aws-lambda-go-adapter)](https://goreportcard.com/report/github.com/Evernorth/aws-lambda-go-adapter)
+[![GoDoc](https://godoc.org/github.com/Evernorth/aws-lambda-go-adapter?status.svg)](https://godoc.org/github.com/Evernorth/aws-lambda-go-adapter)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Release](https://img.shields.io/github/v/release/Evernorth/aws-lambda-go-adapter)](https://github.com/Evernorth/aws-lambda-go-adapter/releases)
+
+## Description
 This module makes it easy to test a Golang AWS Lambda outside of AWS, without needing Docker.  Currently, 
 only HTTP triggers are supported, but additional triggers may be supported in the future.
 
-## How it works
+### How it works
 Lambda Function in AWS:
 1. The main function calls the lambda.Start function, passing in the Handler function.
 2. AWS Lambda invokes the Handler function when an HTTP request is received.
@@ -13,15 +20,16 @@ Testing a Lambda Function outside of AWS:
 2. The httpadapter listens for incoming HTTP requests on the specified port and invokes the Handler function when a request is received.
 ![diagram2](docs/images/diagram2.png)
 
-## Installation
-```go get -u github.com/Evernorth/aws-lambda-go-adapter```
-
+
 ## Features
 * Supports APIGatewayV2HTTP, APIGatewayProxy, and ALBTargetGroup events.
 * Supports handler functions with and without context.Context parameters.
 * Supports both values and pointers for handler function request events.
 * Supports both values and pointers for handler function response events.
 
+## Installation
+```go get -u github.com/Evernorth/aws-lambda-go-adapter```
+
 ## Usage
 ```
 package main

diff --git a/httpadapter/httpadapter.go b/httpadapter/httpadapter.go
@@ -1,3 +1,8 @@
+/*
+Package httpadapter makes it easy to test a Golang AWS Lambda outside of AWS, without needing Docker, by providing HTTP trigger support.
+
+See documentation: https://pkg.go.dev/github.com/Evernorth/aws-lambda-go-adapter
+*/
 package httpadapter
 
 import (