twist

README

twist

Twist generates canonical imports for your Go packages. Since it does not require a running server (ie in existing tools like uber-go/sally and rsc/go-import-redirector), Twist is particularly useful in conjunction with GitHub Pages.

A canonical import path allows you to make your package import a little fancier with a custom domain, for example:

- import "github.com/bobheadxi/zapx"
+ import "go.bobheadxi.dev/zapx"

usage

go get -u go.bobheadxi.dev/twist
#     [        source         ] [     canonical     ]
twist github.com/bobheadxi/zapx go.bobheadxi.dev/zapx

Using the example in this repo:

twist -c twist.example.yml -o x -readme