github.com/creativeprojects/go-selfupdate@v1.2.0/doc.go (about)

     1  /*
     2  go-selfupdate detects the information of the latest release via GitHub Releases API and checks the current version.
     3  If newer version than itself is detected, it downloads released binary from GitHub and replaces itself.
     4  
     5  - Automatically detects the latest version of released binary on GitHub
     6  
     7  - Retrieve the proper binary for the OS and arch where the binary is running
     8  
     9  - Update the binary with rollback support on failure
    10  
    11  - Tested on Linux, macOS and Windows
    12  
    13  - Many archive and compression formats are supported (zip, gzip, xzip, bzip2, tar)
    14  
    15  There are some naming rules. Please read following links.
    16  
    17  Naming Rules of Released Binaries:
    18    https://github.com/creativeprojects/go-selfupdate#naming-rules-of-released-binaries
    19  
    20  Naming Rules of Git Tags:
    21    https://github.com/creativeprojects/go-selfupdate#naming-rules-of-versions-git-tags
    22  
    23  This package is hosted on GitHub:
    24    https://github.com/creativeprojects/go-selfupdate
    25  
    26  Small CLI tools as wrapper of this library are available also:
    27    https://github.com/creativeprojects/go-selfupdate/cmd/detect-latest-release
    28    https://github.com/creativeprojects/go-selfupdate/cmd/go-get-release
    29  */
    30  package selfupdate