Skip to content
This repository has been archived by the owner on Jun 25, 2022. It is now read-only.

Commit

Permalink
Merge pull request #297 from gochigo/update-readme
Browse files Browse the repository at this point in the history
fixed readme and version bump up
  • Loading branch information
paganotoni authored Nov 23, 2021
2 parents 410d31e + 3aab0cf commit c4f5900
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 7 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ jobs:
uses: actions/checkout@v2
with:
fetch-depth: 1
- name: Setup Go ${{ matrix.go-version }}
uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go-version }}
- name: Test
run: |
go test -race ./...
go test -race -cover -v ./...
go install -v ./packr2
47 changes: 42 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
**NOTICE: Please consider migrating your projects to github.com/markbates/pkger. It has an idiomatic API, minimal dependencies, a stronger test suite (tested directly against the std lib counterparts), transparent tooling, and more.**
**NOTICE: Please consider migrating your projects to
[embed](https://pkg.go.dev/embed) which is native file embedding feature of Go,
or github.com/markbates/pkger. It has an idiomatic API, minimal dependencies, a stronger test suite (tested directly against the std lib counterparts), transparent tooling, and more.**

https://blog.gobuffalo.io/introducing-pkger-static-file-embedding-in-go-1ce76dc79c65

Expand All @@ -9,20 +11,55 @@ https://blog.gobuffalo.io/introducing-pkger-static-file-embedding-in-go-1ce76dc7

Packr is a simple solution for bundling static assets inside of Go binaries. Most importantly it does it in a way that is friendly to developers while they are developing.

At this moment, supported go versions are:

* 1.16.x
* 1.17.x

even though it may (or may not) working well with older versions.

## Intro Video

To get an idea of the what and why of Packr, please enjoy this short video: [https://vimeo.com/219863271](https://vimeo.com/219863271).

## Library Installation

```text
$ go get -u github.com/gobuffalo/packr/v2/...
### Go 1.16 and above

```console
$ go install github.com/gobuffalo/packr/v2@v2.8.3
```

or

```console
$ go install github.com/gobuffalo/packr/v2@latest
```

### Go 1.15 and below

```console
$ go get -u github.com/gobuffalo/packr/...
```

## Binary Installation

```text
$ go get -u github.com/gobuffalo/packr/v2/packr2
### Go 1.16 and above

```console
$ go install github.com/gobuffalo/packr/v2/packr2@v2.8.3
```

or

```console
$ go install github.com/gobuffalo/packr/v2/packr2@latest
```

### Go 1.15 and below

```console
$ go get -u github.com/gobuffalo/packr/packr2
```

## New File Format FAQs
Expand Down
2 changes: 1 addition & 1 deletion version.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package packr

// Version of Packr
const Version = "v2.8.1"
const Version = "v2.8.3"

0 comments on commit c4f5900

Please # to comment.