doc: added README.md

[sttk]

T/O.

[Copilot]

Pull Request Overview

A new README.md file has been added to document the 'errs' package, its usage, and its supported Go versions.

• Added package description and features
• Provided installation, usage examples, and test results
• Documented supported Go versions and licensing

Comments suppressed due to low confidence (2)

README.md:6

• Consider changing 'its fields represents' to 'its fields represent' for correct verb agreement.

This package provides the structure type `Err` which takes a parameter of any type as a reason of an error. This parameter is typically a structure type, and its name represents the reason, and its fields represents the situation where the error occurred.

README.md:120

• There appears to be a typo in the type name 'FailToDoSomethong'; it is likely intended to be 'FailToDoSomething'.

case FailToDoSomethong:

[Copilot]

Pull Request Overview

This pull request adds a new README.md to document the usage and features of the errs package for structured error handling in Golang.

• Introduces detailed usage examples including error creation, type-safe handling, and error notifications.
• Provides installation instructions and supported Go version test results.

Comments suppressed due to low confidence (1)

README.md:91

• [nitpick] The printed identifier 'FailToDoWithParam' is inconsistent with the structure name 'FailToDoWithParams'. Consider updating the identifier for clarity and consistency.

fmt.Println(err.Reason())  // => path/to/pkg.FailToDoWithParam { Param1: abc, Param2: 123 }

[Copilot]

Pull Request Overview

This pull request adds a new README.md file that documents the usage, installation, and features of the errs package for error handling in Go.

• Introduces package overview and feature list
• Provides code examples for creating and handling errors
• Details installation instructions and supported Go versions

Comments suppressed due to low confidence (1)

README.md:95

• There is an inconsistency in the error output; the example shows 'FailToDoWithParam' while the defined type is 'FailToDoWithParams'. Please update the output to match the type name.

fmt.Println(err.Error())   // => github.com/sttk/errs.Err { reason = path/to/pkg.FailToDoWithParam { Param1: abc, Param2: 123 }, file = source_file.go, line = 123, cause = I/O timeout }

[Copilot]

Pull Request Overview

This PR adds the initial README.md file with documentation for the errs package. Key changes include adding project description, installation instructions, usage examples, and test results for supported Go versions.

Comments suppressed due to low confidence (1)

README.md:5

• [nitpick] Consider changing 'as a reason of an error' to 'as a reason for an error' to improve clarity.

This package provides the structure type `Err` which takes a parameter of any type as a reason of an error.

[Copilot]

Pull Request Overview

This PR introduces a new README documenting the errs package, its features, usage instructions, installation steps, and supported Go versions.

• Adds a detailed README with code examples and instructions.
• Provides clear examples for creating and handling errors, as well as integrating error notification.

[Copilot]

Pull Request Overview

This PR adds a new README.md to document the errs package for handling errors in Go programs.

• Introduces project description and usage examples
• Provides installation instructions, code examples, and test results
• Includes license and reference links