mirror
/
pkger
mirror of https://github.com/markbates/pkger.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Document that go:embed exists and is usually a better solution

This commit is contained in:
Ryan David Sheasby 2021-08-27 23:34:12 +02:00 committed by GitHub
parent 0273362499
commit 096a68600a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -7,6 +7,11 @@
* Go 1.13+
* Go Modules
## Disclaimer
You probably don't need this library anymore. Although it was very useful in its time, Go now has built-in file embedding functionality as of Go 1.16. Being natively supported, `go:embed` is notably easier to use, as it doesn't require importing external libraries, or running an explicit pre-build step to generate the embedded file data. See the Go embed documentation for more details: https://pkg.go.dev/embed
However, if you're unconvinced or still need to use `pkger` for whatever reason, read on:
## How it Works (Module Aware Pathing)
Pkger is powered by the dark magic of Go Modules, so they're like, totally required.