search

alexzorin / authy

Go library and program to access your Authy TOTP secrets.
MIT License
800 stars 57 forks source link

📚 Add installation instructions to README #5

Closed goodevilgenius closed 4 years ago

goodevilgenius commented 4 years ago

Since not everyone is familiar with go, it would be useful to include installation instructions.

The mention of the version of go was added because using an older version (such as the default version that comes with the most recent Linux Mint) results in the error

# github.com/alexzorin/authy/cmd/authy-export
go/src/github.com/alexzorin/authy/cmd/authy-export/authy-export.go:237:19: undefined: os.UserHomeDir
alexzorin commented 4 years ago

Thanks, I definitely agree that it's a good idea to add some installation instructions.

What is not obvious at the moment is that you can download pre-built binaries for Linux, Windows and macOS from https://github.com/alexzorin/authy/releases . These don't require installation or any knowledge of Go. But the link is hard to find in the GitHub UI.

I would prefer if the README pointed to that page as the primary installation method.

Adding those "easy" instructions also means we don't have to be so hand-holding about the Go instructions, so maybe they can be reduced to something like:

Alternatively, you can compile it from source yourself, which requires Go 1.12 or newer: 

go get github.com/alexzorin/authy/cmd/authy-export