diff --git a/README.md b/README.md index ae74c68..55453db 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # Go repo template - You can use this template to create a new golang repo. - __Note:__ This template is not a golang project, it is a template for creating a new golang repo. - Also the README file here only works with repos. - If you create a repo, you will need to change the README file to suit your needs. Especially the repo info badges, which can only be done with repos. + Also the README file here only works with ___public___ repos. + If you create a ___private___ repo, you will need to change the README file to suit your needs. Badges referencing a repo can only be seen on ___public___ repos. ___Private___ repos are not visible to the badge service. + - __Note:__ The wakatime badge requires a wakatime account. - After creating the new repo, you can replace the GLPv3 license with another license that suits you, if required. -- Then start your golang project with go mod init +- Then start your golang project with go mod init. [![GitHub forks](https://img.shields.io/github/forks/Lerking/golang-repo-template.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Lerking/golang-repo-template/forks/) [![GitHub stars](https://img.shields.io/github/stars/Lerking/golang-repo-template.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Lerking/golang-repo-template/stargazers/)