Merge pull request #3 from moul/dev/moul/template-post-clone

Author: moul

.all-contributorsrc

@@ -29,7 +29,7 @@
     }
   ],
   "contributorsPerLine": 7,
-  "projectName": "golang-repo-template",
+  "projectName": "chizap",
   "projectOwner": "moul",
   "repoType": "github",
   "repoHost": "https://github.com",

.github/workflows/docker.yml

@@ -1,16 +1,16 @@
-Copyright 2021  Manfred Touron and other golang-repo-template Developers.
+Copyright 2021  Manfred Touron and other chizap Developers.
 
 Intellectual Property Notice
 ----------------------------
 
-golang-repo-template is licensed under the Apache License, Version 2.0
+chizap is licensed under the Apache License, Version 2.0
 (see LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) or
 the MIT license (see LICENSE-MIT or http://opensource.org/licenses/MIT),
 at your option.
 
-Copyrights and patents in the golang-repo-templates project are retained
+Copyrights and patents in the chizaps project are retained
 by contributors.
-No copyright assignment is required to contribute to golang-repo-template.
+No copyright assignment is required to contribute to chizap.
 
     SPDX-License-Identifier: (Apache-2.0 OR MIT)
 

.goreleaser.yml

@@ -1,15 +1,11 @@
-GOPKG ?=	moul.io/golang-repo-template
-DOCKER_IMAGE ?=	moul/golang-repo-template
-GOBINS ?=	.
-NPM_PACKAGES ?=	.
+GOPKG ?=	moul.io/chizap
 
 include rules.mk
 
-generate: install
+generate:
 	GO111MODULE=off go get github.com/campoy/embedmd
 	mkdir -p .tmp
-	echo 'foo@bar:~$$ golang-repo-template hello world' > .tmp/usage.txt
-	golang-repo-template hello world 2>&1 >> .tmp/usage.txt
+	go doc -all > .tmp/godoc.txt
 	embedmd -w README.md
 	rm -rf .tmp
 .PHONY: generate

AUTHORS

@@ -1,48 +1,78 @@
-# golang-repo-template
+# chizap
 
-:smile: golang-repo-template
+:smile: chizap
 
-[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/moul.io/golang-repo-template)
-[![License](https://img.shields.io/badge/license-Apache--2.0%20%2F%20MIT-%2397ca00.svg)](https://github.com/moul/golang-repo-template/blob/main/COPYRIGHT)
-[![GitHub release](https://img.shields.io/github/release/moul/golang-repo-template.svg)](https://github.com/moul/golang-repo-template/releases)
-[![Docker Metrics](https://images.microbadger.com/badges/image/moul/golang-repo-template.svg)](https://microbadger.com/images/moul/golang-repo-template)
+[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/moul.io/chizap)
+[![License](https://img.shields.io/badge/license-Apache--2.0%20%2F%20MIT-%2397ca00.svg)](https://github.com/moul/chizap/blob/main/COPYRIGHT)
+[![GitHub release](https://img.shields.io/github/release/moul/chizap.svg)](https://github.com/moul/chizap/releases)
+[![Docker Metrics](https://images.microbadger.com/badges/image/moul/chizap.svg)](https://microbadger.com/images/moul/chizap)
 [![Made by Manfred Touron](https://img.shields.io/badge/made%20by-Manfred%20Touron-blue.svg?style=flat)](https://manfred.life/)
 
-[![Go](https://github.com/moul/golang-repo-template/workflows/Go/badge.svg)](https://github.com/moul/golang-repo-template/actions?query=workflow%3AGo)
-[![Release](https://github.com/moul/golang-repo-template/workflows/Release/badge.svg)](https://github.com/moul/golang-repo-template/actions?query=workflow%3ARelease)
-[![PR](https://github.com/moul/golang-repo-template/workflows/PR/badge.svg)](https://github.com/moul/golang-repo-template/actions?query=workflow%3APR)
-[![GolangCI](https://golangci.com/badges/github.com/moul/golang-repo-template.svg)](https://golangci.com/r/github.com/moul/golang-repo-template)
-[![codecov](https://codecov.io/gh/moul/golang-repo-template/branch/main/graph/badge.svg)](https://codecov.io/gh/moul/golang-repo-template)
-[![Go Report Card](https://goreportcard.com/badge/moul.io/golang-repo-template)](https://goreportcard.com/report/moul.io/golang-repo-template)
-[![CodeFactor](https://www.codefactor.io/repository/github/moul/golang-repo-template/badge)](https://www.codefactor.io/repository/github/moul/golang-repo-template)
-
-[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/moul/golang-repo-template)
+[![Go](https://github.com/moul/chizap/workflows/Go/badge.svg)](https://github.com/moul/chizap/actions?query=workflow%3AGo)
+[![Release](https://github.com/moul/chizap/workflows/Release/badge.svg)](https://github.com/moul/chizap/actions?query=workflow%3ARelease)
+[![PR](https://github.com/moul/chizap/workflows/PR/badge.svg)](https://github.com/moul/chizap/actions?query=workflow%3APR)
+[![GolangCI](https://golangci.com/badges/github.com/moul/chizap.svg)](https://golangci.com/r/github.com/moul/chizap)
+[![codecov](https://codecov.io/gh/moul/chizap/branch/main/graph/badge.svg)](https://codecov.io/gh/moul/chizap)
+[![Go Report Card](https://goreportcard.com/badge/moul.io/chizap)](https://goreportcard.com/report/moul.io/chizap)
+[![CodeFactor](https://www.codefactor.io/repository/github/moul/chizap/badge)](https://www.codefactor.io/repository/github/moul/chizap)
+
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/moul/chizap)
+
+## Example
+
+[embedmd]:# (example_test.go /import\ / $)
+```go
+import (
+	"github.com/go-chi/chi"
+	"go.uber.org/zap"
+	"moul.io/chizap"
+)
+
+func Example() {
+	logger := zap.NewExample()
+	r := chi.NewRouter()
+	r.Use(chizap.New(logger, &chizap.Opts{
+		WithReferer:   true,
+		WithUserAgent: true,
+	}))
+}
+```
 
 ## Usage
 
-[embedmd]:# (.tmp/usage.txt console)
-```console
-foo@bar:~$ golang-repo-template hello world
-            _                                                   _                      _        _
- __ _  ___ | | __ _  _ _   __ _  ___  _ _  ___  _ __  ___  ___ | |_  ___  _ __   _ __ | | __ _ | |_  ___
-/ _` |/ _ \| |/ _` || ' \ / _` ||___|| '_|/ -_)| '_ \/ _ \|___||  _|/ -_)| '  \ | '_ \| |/ _` ||  _|/ -_)
-\__, |\___/|_|\__,_||_||_|\__, |     |_|  \___|| .__/\___/      \__|\___||_|_|_|| .__/|_|\__,_| \__|\___|
-|___/                     |___/                |_|                              |_|
-12 CPUs, /home/moul/.gvm/pkgsets/go1.16/global/bin/golang-repo-template, fwrz, go1.16
-args ["golang-repo-template","hello","world"]
+[embedmd]:# (.tmp/godoc.txt txt /FUNCTIONS/ $)
+```txt
+FUNCTIONS
+
+func New(logger *zap.Logger, opts *Opts) func(next http.Handler) http.Handler
+    New returns a logger middleware for chi, that implements the http.Handler
+    interface.
+
+
+TYPES
+
+type Opts struct {
+	// WithReferer enables logging the "Referer" HTTP header value.
+	WithReferer bool
+
+	// WithUserAgent enables logging the "User-Agent" HTTP header value.
+	WithUserAgent bool
+}
+    Opts contains the middleware configuration.
+
 ```
 
 ## Install
 
 ### Using go
 
 ```sh
-go get moul.io/golang-repo-template
+go get moul.io/chizap
 ```
 
 ### Releases
 
-See https://github.com/moul/golang-repo-template/releases
+See https://github.com/moul/chizap/releases
 
 ## Contribute
 
@@ -73,7 +103,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="http://manfred.life"><img src="https://avatars1.githubusercontent.com/u/94029?v=4" width="100px;" alt=""/><br /><sub><b>Manfred Touron</b></sub></a><br /><a href="#maintenance-moul" title="Maintenance">🚧</a> <a href="https://github.com/moul/golang-repo-template/commits?author=moul" title="Documentation">📖</a> <a href="https://github.com/moul/golang-repo-template/commits?author=moul" title="Tests">⚠️</a> <a href="https://github.com/moul/golang-repo-template/commits?author=moul" title="Code">💻</a></td>
+    <td align="center"><a href="http://manfred.life"><img src="https://avatars1.githubusercontent.com/u/94029?v=4" width="100px;" alt=""/><br /><sub><b>Manfred Touron</b></sub></a><br /><a href="#maintenance-moul" title="Maintenance">🚧</a> <a href="https://github.com/moul/chizap/commits?author=moul" title="Documentation">📖</a> <a href="https://github.com/moul/chizap/commits?author=moul" title="Tests">⚠️</a> <a href="https://github.com/moul/chizap/commits?author=moul" title="Code">💻</a></td>
     <td align="center"><a href="https://manfred.life/moul-bot"><img src="https://avatars1.githubusercontent.com/u/41326314?v=4" width="100px;" alt=""/><br /><sub><b>moul-bot</b></sub></a><br /><a href="#maintenance-moul-bot" title="Maintenance">🚧</a></td>
   </tr>
 </table>
@@ -87,7 +117,7 @@ specification. Contributions of any kind welcome!
 
 ### Stargazers over time
 
-[![Stargazers over time](https://starchart.cc/moul/golang-repo-template.svg)](https://starchart.cc/moul/golang-repo-template)
+[![Stargazers over time](https://starchart.cc/moul/chizap.svg)](https://starchart.cc/moul/chizap)
 
 ## License