diff --git a/.readme.tmpl b/.readme.tmpl index 3a6d06f72..4fea3027a 100644 --- a/.readme.tmpl +++ b/.readme.tmpl @@ -1,7 +1,15 @@ # :zap: zap [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] +
+ Blazing fast, structured, leveled logging in Go. +![Zap logo](assets/logo.png) + +[![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] + +
+ ## Installation `go get -u go.uber.org/zap` diff --git a/README.md b/README.md index b4c75b110..a17035cb6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ -# :zap: zap [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] +# :zap: zap + + +
Blazing fast, structured, leveled logging in Go. +![Zap logo](assets/logo.png) + +[![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] + +
+ ## Installation `go get -u go.uber.org/zap` diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 000000000..f78cf08b3 --- /dev/null +++ b/assets/README.md @@ -0,0 +1,5 @@ +The logo for Zap was designed by [Abhinav Gupta](https://abhinavg.net/) +and is made available under the Creative Commons 4.0 Attribution License. + +It is based on the Go Gopher mascot originally created by Renee French, +which is also licensed under the Creative Commons 4.0 Attribution License. diff --git a/assets/go.mod b/assets/go.mod new file mode 100644 index 000000000..6e1a9fa78 --- /dev/null +++ b/assets/go.mod @@ -0,0 +1,3 @@ +module go.uber.org/zap/assets + +go 1.21.5 diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 000000000..f7c30c03d Binary files /dev/null and b/assets/logo.png differ