aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/matoous/godox/README.md
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2020-07-04 11:12:55 +0200
committerDmitry Vyukov <dvyukov@google.com>2020-07-04 15:05:30 +0200
commitc7d7f10bdff703e4a3c0414e8a33d4e45c91eb35 (patch)
tree0dff0ee1f98dbfa3ad8776112053a450d176592b /vendor/github.com/matoous/godox/README.md
parent9573094ce235bd9afe88f5da27a47dd6bcc1e13b (diff)
go.mod: vendor golangci-lint
Diffstat (limited to 'vendor/github.com/matoous/godox/README.md')
-rw-r--r--vendor/github.com/matoous/godox/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/vendor/github.com/matoous/godox/README.md b/vendor/github.com/matoous/godox/README.md
new file mode 100644
index 000000000..6d5f54fc6
--- /dev/null
+++ b/vendor/github.com/matoous/godox/README.md
@@ -0,0 +1,18 @@
+GoDoX
+===
+
+[![Tests](https://github.com/matoous/godox/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/matoous/godox/actions)
+[![Lint](https://github.com/matoous/godox/workflows/.github/workflows/lint.yml/badge.svg)](https://github.com/matoous/godox/actions)
+[![GoDoc](https://godoc.org/github.com/matoous/godox?status.svg)](https://godoc.org/github.com/matoous/godox)
+[![Go Report Card](https://goreportcard.com/badge/github.com/matoous/godox)](https://goreportcard.com/report/github.com/matoous/godox)
+[![GitHub issues](https://img.shields.io/github/issues/matoous/godox.svg)](https://github.com/matoous/godox/issues)
+[![License](https://img.shields.io/badge/license-MIT%20License-blue.svg)](https://github.com/matoous/godox/LICENSE)
+
+GoDoX extracts comments from Go code based on keywords. This repository is fork of https://github.com/766b/godox
+but a lot of code has changed, this repository is updated and the code was adjusted for better integration with
+https://github.com/golangci/golangci-lint.
+
+Installation
+---
+
+ go get github.com/matoous/godox