rorecek / module-skeleton

A skeleton repository for Golang modules

:module_description

Note: Replace :author_name :author_username :author_email :module_name :module_description with their correct values in README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md and go.mod files, then delete this line. This module skeleton is heavily inspired by package-skeleton-php by Spatie.

This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example.

Installation

You can install this module with go get command:

go get -u github.com/:author_username/:module_name

Usage

import "github.com/:author_username/:module_name"

:module_name.Hello() // Hello, world!

Testing

go test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

• :author_name
• All Contributors

License

The MIT License (MIT). Please see License File for more information.