aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-08-31 12:00:23 -0400
committerEugene Triguba <eugenetriguba@gmail.com>2024-08-31 12:00:23 -0400
commitc499a652bd61f406d1aeaad4fae889e754a78605 (patch)
treef809334fff0d9dc881af704e34f9f018a62dbaf9
parentUse codecov token (diff)
downloadenvelope-c499a652bd61f406d1aeaad4fae889e754a78605.zip
Update readme
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index ed46d3b..9fafc14 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
# Envelope
+<p>
+ <a href="https://godoc.org/github.com/eugenetriguba/envelope">
+ <img src="https://godoc.org/github.com/eugenetriguba/envelope?status.svg" alt="GoDoc">
+ </a>
+ <a href="https://goreportcard.com/report/github.com/eugenetriguba/envelope">
+ <img src="https://goreportcard.com/badge/github.com/eugenetriguba/envelope" alt="Go Report Card Badge">
+ </a>
+ <a href="https://codecov.io/github/eugenetriguba/envelope">
+ <img src="https://codecov.io/gh/eugenetriguba/envelope/graph/badge.svg?token=1nxWoiXv66"/>
+ </a>
+ <img alt="Version Badge" src="https://img.shields.io/badge/version-0.1.0-blue" style="max-width:100%;">
+</p>
+
+Envelope is a Go library that enables populating Go structs from environment variables.
+
+## Installation
+
+To install Envelope, use the following command:
+
+```bash
+$ go get github.com/eugenetriguba/envelope
+```