Skip to content

Commit

Permalink
update readme with v2 paths (#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcasali-atlassian authored Nov 5, 2024
1 parent 9ec3808 commit b586b3c
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Download the `lock-exec` binary from the [releases page](https://github.com/loom

```shell
# Using Go
go install github.com/loomhq/lock-exec@latest
go install github.com/loomhq/lock-exec/v2@latest

# Using Docker
docker run ghcr.io/loomhq/lock-exec --help
Expand All @@ -70,3 +70,10 @@ $ go run main.go run testkey 'echo "hello world"' -t loomctl-locks
```

Once the command finishes running `lock-exec` will unlock the key. It also listens for os interrupts and unlocks the key before exiting. In the rare case where `lock-exec` exits and fails to unlock the key will remain locked for the next 24 hours (you can customize this with `--expire <duration>`). The key can manually be unlocked earlier using `lock-exec unlock <key>`.

## Package

The `lock` package can be utilized independently of the CLI tool. The package can be imported into a Go project using go get.
```shell
go get github.com/loomhq/lock-exec/v2
```

0 comments on commit b586b3c

Please sign in to comment.