Added info about using commands to README.md; formatted markdown.

Fixes #52 Signed-off-by: Bartlomiej Plotka <bwplotka@gmail.com>
bwplotka · Dec 27, 2020 · 7e226bf · 7e226bf
1 parent f6ebd25
commit 7e226bf
Show file tree

Hide file tree

Showing 7 changed files with 195 additions and 89 deletions.
diff --git a/.bingo/Variables.mk b/.bingo/Variables.mk
@@ -46,6 +46,12 @@ $(GOLANGCI_LINT): .bingo/golangci-lint.mod
 	@echo "(re)installing $(GOBIN)/golangci-lint-v1.26.0"
 	@cd .bingo && $(GO) build -mod=mod -modfile=golangci-lint.mod -o=$(GOBIN)/golangci-lint-v1.26.0 "github.com/golangci/golangci-lint/cmd/golangci-lint"
 
+MDOX := $(GOBIN)/mdox-v0.1.1-0.20201227090259-ed1982910b0d
+$(MDOX): .bingo/mdox.mod
+	@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies.
+	@echo "(re)installing $(GOBIN)/mdox-v0.1.1-0.20201227090259-ed1982910b0d"
+	@cd .bingo && $(GO) build -mod=mod -modfile=mdox.mod -o=$(GOBIN)/mdox-v0.1.1-0.20201227090259-ed1982910b0d "github.com/bwplotka/mdox"
+
 MISSPELL := $(GOBIN)/misspell-v0.3.4
 $(MISSPELL): .bingo/misspell.mod
 	@# Install binary/ries using Go 1.14+ build command. This is using bwplotka/bingo-controlled, separate go module with pinned dependencies.

diff --git a/.bingo/mdox.mod b/.bingo/mdox.mod
@@ -0,0 +1,5 @@
+module _ // Auto generated by https://github.com/bwplotka/bingo. DO NOT EDIT
+
+go 1.15
+
+require github.com/bwplotka/mdox v0.1.1-0.20201227090259-ed1982910b0d
diff --git a/.bingo/variables.env b/.bingo/variables.env
@@ -18,5 +18,7 @@ GOIMPORTS="${GOBIN}/goimports-v0.0.0-20200519204825-e64124511800"
 
 GOLANGCI_LINT="${GOBIN}/golangci-lint-v1.26.0"
 
+MDOX="${GOBIN}/mdox-v0.1.1-0.20201227090259-ed1982910b0d"
+
 MISSPELL="${GOBIN}/misspell-v0.3.4"
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 NOTE: As semantic versioning states all 0.y.z releases can contain breaking changes in API (flags, grpc API, any backward compatibility)
 
@@ -34,21 +33,19 @@ We use *breaking* word for marking changes that are not backward compatible (rel
 
 ### Fixed
 
-*  Fixed extra whitespace in variables.env.
+* Fixed extra whitespace in variables.env.
 
 ## [v0.2.0](https://github.com/bwplotka/bingo/releases/tag/v0.2.0) - 2020.06.04
 
 ### Changed
 
-* Added `.variables.env` file to bingo moddir for easy export of all environment variables to the current shell. Removed `-m` and `-makefile` flags.
-Bingo now always creates makefile and env file and never generate `include` to avoid many corner cases. It's now documented how to add `include` in the documentation.
+* Added `.variables.env` file to bingo moddir for easy export of all environment variables to the current shell. Removed `-m` and `-makefile` flags. Bingo now always creates makefile and env file and never generate `include` to avoid many corner cases. It's now documented how to add `include` in the documentation.
 
 ## [v0.1.1](https://github.com/bwplotka/bingo/releases/tag/v0.1.1) - 2020.06.03
 
 ### Fixed
 
-* [#22](https://github.com/bwplotka/bingo/pull/22) Fixed problem with running bingo in non-Go project. From now on it also maintains
-fake go.mod to resolve issues like:
+* [#22](https://github.com/bwplotka/bingo/pull/22) Fixed problem with running bingo in non-Go project. From now on it also maintains fake go.mod to resolve issues like:
 
 ```
 `Error: get command failed: 0: getting : go get -d: go: cannot find main module, but -modfile was set.
@@ -59,5 +56,4 @@ fake go.mod to resolve issues like:
 
 Initial release.
 
-Why 0.1.0? Well, because we plan to release 1.0 once we introduce this tool to [Thanos](http://github.com/thanos-io/thanos) and [go-grpc-middleware](https://github.com/grpc-ecosystem/go-grpc-middleware) as the final test (:
-After having this usage stable for a bit, and we are sure flags will not change, we can claim 1.0.
+Why 0.1.0? Well, because we plan to release 1.0 once we introduce this tool to [Thanos](http://github.com/thanos-io/thanos) and [go-grpc-middleware](https://github.com/grpc-ecosystem/go-grpc-middleware) as the final test (: After having this usage stable for a bit, and we are sure flags will not change, we can claim 1.0.
diff --git a/Makefile b/Makefile
@@ -40,7 +40,7 @@ all: format build
 
 .PHONY: build
 build: ## Build bingo.
-	@echo ">> Building bingo"
+	@echo ">> building bingo"
 	@go install github.com/bwplotka/bingo
 
 .PHONY: check-comments
@@ -54,10 +54,9 @@ deps: ## Ensures fresh go.mod and go.sum.
 	@go mod verify
 
 .PHONY: docs
-docs: build $(EMBEDMD) ## Generates docs from flags.
-	@$(GOBIN)/bingo -h > bingo-help.txt
-	@$(EMBEDMD) -w *.md
-	@rm -f bingo-help.txt
+docs: build $(MDOX) ## Generates config snippets and doc formatting.
+	@echo ">> generating docs $(PATH)"
+	@$(MDOX) fmt -l *.md
 
 .PHONY: format
 format: ## Formats Go code including imports and cleans up white noise.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,5 +18,7 @@ GOIMPORTS="${GOBIN}/goimports-v0.0.0-20200519204825-e64124511800"

		GOLANGCI_LINT="${GOBIN}/golangci-lint-v1.26.0"

		MDOX="${GOBIN}/mdox-v0.1.1-0.20201227090259-ed1982910b0d"

		MISSPELL="${GOBIN}/misspell-v0.3.4"