summaryrefslogtreecommitdiff
path: root/example/example.go
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2021-10-17 02:33:09 +0700
committerShulhan <ms@kilabit.info>2021-10-17 02:33:09 +0700
commitd1bb05be9538a793fca37d3dcdcb8f637134398e (patch)
tree6e57b4f02a11fa0aa82b246b974e2181e8083883 /example/example.go
parented3d14a77a3c2736c7b563bd52473c43a62f813b (diff)
downloadgorankusu-d1bb05be9538a793fca37d3dcdcb8f637134398e.tar.xz
all: move the main program for example to internal/cmd/trunks-example
The "cmd" directory on module should be reserved for installable program that can be executed outside of this repository. The trunks-example is development server should be run on root of this repository only, not installable to $GOBIN.
Diffstat (limited to 'example/example.go')
-rw-r--r--example/example.go8
1 files changed, 6 insertions, 2 deletions
diff --git a/example/example.go b/example/example.go
index 963f7e0..56f7d7c 100644
--- a/example/example.go
+++ b/example/example.go
@@ -1,6 +1,10 @@
//
-// Package example provide an example how to use the Trunks library from setup
-// to creating targets.
+// Package example provide an example how to use the Trunks library from
+// setting it up to creating targets.
+//
+// To run the example, execute
+//
+// $ go run ./internal/cmd/trunks-example
//
package example