Skip to content

Commit

Permalink
docs: update readme re: go modules (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
judwhite authored Feb 1, 2021
1 parent 06db9b4 commit 3d7c0d2
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,23 @@ Go Windows Service wrapper that plays nice with Linux. Windows tests [here](http
- Used in Production.
- Maintained. Issues and Pull Requests will be responded to.

## Install
## Go Modules

`go get -u github.com/judwhite/go-svc`
* Please note the `import` path and `go.mod` change from `github.com/judwhite/go-svc/svc` to `github.com/judwhite/go-svc` for `v1.2+`
* `v1.1.3` and earlier can be imported using the previous import path
* `v1.2+` code is backwards compatible with previous versions

```nginx no-this-isnt-nginx-but-the-syntax-highlighting-works
module awesomeProject
go 1.15
require github.com/judwhite/go-svc v1.2.0
```

```go
import "github.com/judwhite/go-svc"
```

## Example

Expand Down

0 comments on commit 3d7c0d2

Please sign in to comment.