pkgre

README

Routing examples • Contributing • License

The pkg.re service provides versioned URLs that offer the proper metadata for redirecting the go tool onto well defined GitHub repositories. Developers that choose to use this service are strongly encouraged to not make any backwards incompatible changes without also changing the version in the package URL. This convention improves the chances that dependent code will continue to work while depended upon packages evolve.

The advantage of using pkg.re is that the URL is cleaner, shorter, redirects to the package documentation at godoc.org when opened with a browser, handles git branches and tags for versioning, and most importantly encourages the adoption of stable versioned package APIs.

Note that pkg.re does not hold the package code.

pkg.re have backward compatibility with gopkg.in service.

Routing examples

go get pkg.re/essentialkaos/ek.v1        → github.com/essentialkaos/ek tag/branch v1.x.x
go get pkg.re/essentialkaos/ek.v1.6      → github.com/essentialkaos/ek tag/branch v1.6.x
go get pkg.re/essentialkaos/ek.v1.6.8    → github.com/essentialkaos/ek tag/branch v1.6.8
go get pkg.re/essentialkaos/ek.develop   → github.com/essentialkaos/ek tag/branch develop
go get pkg.re/check.v1                   → github.com/go-check/check tag/branch v1.x.x
https://pkg.re/essentialkaos/ek.v1       → https://github.com/essentialkaos/ek/tree/v1.x.x
https://pkg.re/essentialkaos/ek.v1?docs  → https://pkg.go.dev/pkg.re/essentialkaos/ek.v1

x - latest available version

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0