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

doc updates

CHANGELOG.md

@@ -2,6 +2,9 @@ All notable changes to this project will be documented in this file.
 We follow the [Semantic Versioning 2.0.0](http://semver.org/) format.
 
 
+## v1.0.1 2024-10-24
+Updated documentation
+
 ## v1.0.0 2024-10-15
 
 Initial Release

README.md

@@ -6,10 +6,7 @@
 [![Release](https://img.shields.io/github/v/release/Evernorth/http-problemdetails-go)](https://gtihub.com/Evernorth/http-problemdetails-go/releases)
 
 ## Description
-An implementation of [IETF RFC 9457 Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457.html) which is a specification for a standard error structure for HTTP APIs.
-
-## Installation
-```go get -u github.com/Evernorth/http-problemdetails-go```
+Package `problemdetails` is an implementation of [IETF RFC 9457 Problem Details for HTTP APIs](https://www.rfc-editor.org/rfc/rfc9457.html), which is a specification for a standard error structure for HTTP APIs.
 
 ## Features
  - Supports the following HTTP status codes:
@@ -31,6 +28,9 @@ An implementation of [IETF RFC 9457 Problem Details for HTTP APIs](https://www.r
 
 >Note: MIME type must be set in the response header to comply with the RFC 9457 specification.  The `MIMETypeJSON` constant is provided for this purpose.
 
+## Installation
+```go get -u github.com/Evernorth/http-problemdetails-go```
+
 ## Usage
 ### Creating a simple HTTP ProblemDetails
 The example code below demonstrates how to create simple Problem instances as well as how to add information to them using the With* functions.

problemdetails/problemdetails.go

@@ -1,3 +1,8 @@
+/*
+Package problemdetails is an implementation of IETF RFC 9457 Problem Details for HTTP APIs (See: https://www.rfc-editor.org/rfc/rfc9457.html), which is a specification for a standard error structure for HTTP APIs.
+
+See documentation: https://pkg.go.dev/github.com/Evernorth/http-problemdetails-go
+*/
 package problemdetails
 
 import (