Skip to content

Commit 1211a32

Browse files
committed
Minor edits, updates, etc
1 parent 6031e5e commit 1211a32

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

README.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# go-validate
2-
**go-validate** provides validations for struct fields based on a validation tag and offers additional validation functions.
2+
**go-validate** provides validations for struct fields based on a validation tag and offers additional validation functions
33

44
[![Go](https://img.shields.io/github/go-mod/go-version/mrz1836/go-validate)](https://golang.org/)
5-
[![Build Status](https://travis-ci.org/mrz1836/go-validate.svg?branch=master)](https://travis-ci.org/mrz1836/go-validate)
5+
[![Build Status](https://travis-ci.com/mrz1836/go-validate.svg?branch=master)](https://travis-ci.com/mrz1836/go-validate)
66
[![Report](https://goreportcard.com/badge/github.com/mrz1836/go-validate?style=flat)](https://goreportcard.com/report/github.com/mrz1836/go-validate)
7-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e25f7c37ecb246fba1cabf1000aa76a3)](https://www.codacy.com/app/mrz1818/go-validate?utm_source=github.com&utm_medium=referral&utm_content=mrz1836/go-validate&utm_campaign=Badge_Grade)
87
[![Release](https://img.shields.io/github/release-pre/mrz1836/go-validate.svg?style=flat)](https://github.com/mrz1836/go-validate/releases)
9-
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat)](https://github.com/RichardLitt/standard-readme)
10-
[![GoDoc](https://godoc.org/github.com/mrz1836/go-validate?status.svg&style=flat)](https://godoc.org/github.com/mrz1836/go-validate)
8+
[![GoDoc](https://godoc.org/github.com/mrz1836/go-validate?status.svg&style=flat)](https://pkg.go.dev/github.com/mrz1836/go-validate)
119

1210
## Table of Contents
1311
- [Installation](#installation)
@@ -28,20 +26,60 @@ $ go get -u github.com/mrz1836/go-validate
2826
```
2927

3028
## Documentation
31-
You can view the generated [documentation here](https://godoc.org/github.com/mrz1836/go-validate).
29+
You can view the generated [documentation here](https://pkg.go.dev/github.com/mrz1836/go-validate).
30+
31+
<details>
32+
<summary><strong><code>Library Deployment</code></strong></summary>
33+
34+
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.
35+
36+
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
37+
38+
Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
39+
</details>
40+
41+
<details>
42+
<summary><strong><code>Makefile Commands</code></strong></summary>
43+
44+
View all `makefile` commands
45+
```bash
46+
$ make help
47+
```
48+
49+
List of all current commands:
50+
```text
51+
all Runs test, install, clean, docs
52+
bench Run all benchmarks in the Go application
53+
clean Remove previous builds and any test cache data
54+
clean-mods Remove all the Go mod cache
55+
coverage Shows the test coverage
56+
godocs Sync the latest tag with GoDocs
57+
help Show all make commands available
58+
lint Run the Go lint application
59+
release Full production release (creates release in Github)
60+
release-test Full production test release (everything except deploy)
61+
release-snap Test the full release (build binaries)
62+
tag Generate a new tag and push (IE: make tag version=0.0.0)
63+
tag-remove Remove a tag if found (IE: make tag-remove version=0.0.0)
64+
tag-update Update an existing tag to current commit (IE: make tag-update version=0.0.0)
65+
test Runs vet, lint and ALL tests
66+
test-short Runs vet, lint and tests (excludes integration tests)
67+
update Update all project dependencies
68+
update-releaser Update the goreleaser application
69+
vet Run the Go vet application
70+
```
71+
</details>
3272

3373
## Examples & Tests
3474
All unit tests and examples run via [Travis CI](https://travis-ci.org/mrz1836/go-validate) and uses [Go version 1.14.x](https://golang.org/doc/go1.14). View the [deployment configuration file](.travis.yml).
3575
```bash
36-
$ cd ../go-validate
37-
$ go test ./... -v
76+
$ make test
3877
```
3978

4079
## Benchmarks
4180
Run the Go benchmarks:
4281
```bash
43-
$ cd ../go-validate
44-
$ go test -bench . -benchmem
82+
$ make bench
4583
```
4684

4785
## Code Standards
@@ -81,7 +119,9 @@ if !ok {
81119

82120
## Maintainers
83121

84-
[@kayleg](https://github.com/kayleg) - [@MrZ](https://github.com/mrz1836)
122+
| [<img src="https://github.com/mrz1836.png" height="50" alt="MrZ" />](https://github.com/mrz1836) | [<img src="https://github.com/kayleg.png" height="50" alt="kayleg" />](https://github.com/kayleg) |
123+
|:---:|:---:|
124+
| [MrZ](https://github.com/mrz1836) | [kayleg](https://github.com/kayleg) |
85125

86126
## Contributing
87127

0 commit comments

Comments
 (0)