Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
James Ranson committed Mar 5, 2021
1 parent cd242a9 commit e6c2588
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Currently tricktool offers one command, `upgrade-config`, which will upgrade a T
tricktool upgrade-config /etc/trickster.conf > /etc/trickster.yaml
```

## Downloading

Download tricktool from the [Releases](https://github.com/tricksterproxy/tricktool/releases) page, or (if you have golang installed on your device,) run `go get github.com/tricksterproxy/tricktool`, and it will be built and placed in your `$GOBIN`.

## Special Note About the Project

This project is brand new, so while we hope it will work flawlessly for everyone, and has worked for everything we've thrown at it, we're very eager to refine it further while Trickster 2.0 is in Beta. If you are having any problems with `upgrade-config`, please file an [issue](https://github.com/tricksterproxy/tricktool/issues), and if possible, attach a sanitized version of your 1.x configuration.

Likewise, if there are any other useful tools you'd like to see that would facilitate your Trickster deployment, file an [issue](https://github.com/tricksterproxy/tricktool/issues) here with a feature request.

[Contributions](https://github.com/tricksterproxy/tricktool/CONTRIBUTING.md) are always welcome and most appreciated. We work very hard to review PR's within 24 hours and credit the work to the contributor in the next release's notes.

## Downloading

Download tricktool from the [Releases](https://github.com/tricksterproxy/tricktool/releases) page, or (if you have golang installed on your device,) run `go get github.com/tricksterproxy/tricktool`, and it will be built and placed in your `$GOBIN`.

0 comments on commit e6c2588

Please sign in to comment.