Merge pull request #44 from gostaticanalysis/add-prefix-description

Add description of SKELETON_PREFIX usage
gostaticanalysis · Nov 12, 2021 · 7f3de02 · 7f3de02
2 parents 0d6cca6 + 0752ddb
commit 7f3de02
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -139,6 +139,14 @@ skeleton accepts `-kind` option which indicates kind of skeleton code.
 * `-kind=ssa`: generate skeleton code with `buildssa.Analyzer`
 * `-kind=codegen`: generate skeleton code of a code generator
 
+### Module path with prefix
+
+```sh
+$ SKELETON_PREFIX=example.com skeleton pkgname
+$ head -1 pkgname/go.mod
+module example.com/pkgname
+```
+
 ## Build as a plugin for golangci-lint
 
 `skeleton` generates plugin directory which has main.go.