Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] mention the //go:embed feature of the Go compiler since 1.16 #125

Closed
wants to merge 1 commit into from
Closed

[doc] mention the //go:embed feature of the Go compiler since 1.16 #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ statik allows you to embed a directory of static files into your Go binary to be

Is this a crazy idea? No, not necessarily. If you're building a tool that has a Web component, you typically want to serve some images, CSS and JavaScript. You like the comfort of distributing a single binary, so you don't want to mess with deploying them elsewhere. If your static files are not large in size and will be browsed by a few people, statik is a solution you are looking for.

## Go native embedding
Go 1.16 added the [`//go:embed`](https://pkg.go.dev/embed) directive which provides the same functionality
as statik, but with the advantage that it does not require the a pre-compilation
step, or the comitting of possibly large machine generated go files into the repo.
So you may want to use native embedding instead of statik.

## Usage

Install the command line tool first.
Expand Down