search

rog-golang-buddies / golang-template-repository

Kickstarter repository for a golang service
Apache License 2.0
17 stars 7 forks source link

Refresh README #44

Closed haani-niyaz closed 2 years ago

haani-niyaz commented 2 years ago

The currently README is out of date and should be updated to give an intro into how to navigate this repo. Namely, it should provide:

  1. A basic README structure since the bulk of the content will be hosted in gh-pages
  2. A link to this repo's gh-pages site so that users are aware of how to get started.
jmaister commented 2 years ago

Also, I think that the README.md will be overwritten by the projects, so all the info could be lost.

I propose to have a TEMPLATE.md and make a reference from the README.md

# Project Template

This project has been created using [](https://github.com/rog-golang-buddies/golang-template-repository)
Check for more info on [docs/TEMPLATE.md](TEMPLATE info)
haani-niyaz commented 2 years ago

@jmaister thanks for the suggestion.

The README file is to be replaced with the following (hopefully soon): https://github.com/rog-golang-buddies/golang-template-repository/blob/52ad3bc987f10ba57c529024798a713bd824a4f7/README.md

The idea being that the repo owners take control of the README and we try to leave no footprint of the template repo.