From 089c4d7ee1fc5a42a58952b5051051d2ba7f0faf Mon Sep 17 00:00:00 2001 From: mikestefanello Date: Tue, 8 Mar 2022 19:30:37 -0500 Subject: [PATCH] README update. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3804d05..d6eb2e1 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Go Reference](https://pkg.go.dev/badge/github.com/mikestefanello/pagoda.svg)](https://pkg.go.dev/github.com/mikestefanello/pagoda) [![GoT](https://img.shields.io/badge/Made%20with-Go-1f425f.svg)](https://go.dev) - +[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)

Logo

@@ -156,7 +156,15 @@ Ensure the following are installed on your system: ### Start the application -After checking out the repository, from within the root, start the Docker containers for the database and cache by executing `make up`. +After checking out the repository, from within the root, start the Docker containers for the database and cache by executing `make up`: + +``` +git clone git@github.com:mikestefanello/pagoda.git +cd pagoda +make up +``` + +Since this repository is a _template_ and not a Go _library_, you **do not** use `go get`. Once that completes, you can start the application by executing `make run`. By default, you should be able to access the application in your browser at `localhost:8000`.