Merge pull request #17 from wneessen/dev

Replaced "apg.go" with "apg-go"
This commit is contained in:
Winni Neessen 2021-04-17 11:55:47 +02:00 committed by GitHub
commit 7a08e3b429
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -25,8 +25,8 @@ in this git repository
#### Linux/BSD/MacOS #### Linux/BSD/MacOS
* Download release * Download release
```sh ```sh
$ curl -LO https://github.com/wneessen/apg.go/releases/download/v<version>/apg-v<version>-<os>-<architecture>.tar.gz $ curl -LO https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-<os>-<architecture>.tar.gz
$ curl -LO https://github.com/wneessen/apg.go/releases/download/v<version>/apg-v<version>-<os>-<architecture>.tar.gz.sha256 $ curl -LO https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-<os>-<architecture>.tar.gz.sha256
``` ```
* Verify the checksum * Verify the checksum
```sh ```sh
@ -45,8 +45,8 @@ in this git repository
#### Windows #### Windows
* Download release * Download release
```PowerShell ```PowerShell
PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg.go/releases/download/v<version>/apg-v<version>-windows-<architecture>.zip -OutFile apg-v<version>-windows-<architecure>.zip PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-windows-<architecture>.zip -OutFile apg-v<version>-windows-<architecure>.zip
PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg.go/releases/download/v<version>/apg-v<version>-windows-<architecture>.zip.sha256 -OutFile apg-v<version>-windows-<architecure>.zip.sha256 PS> Invoke-RestMethod -Uri https://github.com/wneessen/apg-go/releases/download/v<version>/apg-v<version>-windows-<architecture>.zip.sha256 -OutFile apg-v<version>-windows-<architecure>.zip.sha256
``` ```
* Verify the checksum * Verify the checksum
```PowerShell ```PowerShell
@ -67,7 +67,7 @@ in this git repository
### Sources ### Sources
* Download sources * Download sources
```sh ```sh
$ curl -LO https://github.com/wneessen/apg.go/archive/refs/tags/v<version>.tar.gz $ curl -LO https://github.com/wneessen/apg-go/archive/refs/tags/v<version>.tar.gz
``` ```
* Extract source * Extract source
```sh ```sh
@ -75,7 +75,7 @@ in this git repository
``` ```
* Build binary * Build binary
```sh ```sh
$ cd apg.go-<version> $ cd apg-go-<version>
$ go build -o apg ./... $ go build -o apg ./...
``` ```
* Execute the brand new binary * Execute the brand new binary
@ -91,7 +91,7 @@ $ sudo cp apg /usr/local/bin/apg
``` ```
## CLI parameters ## CLI parameters
_apg.go_ replicates some of the parameters of the original APG. Some parameters are different though: _apg-go_ replicates some of the parameters of the original APG. Some parameters are different though:
- ```-m <length>```: The minimum length of the password to be generated (Default: 12) - ```-m <length>```: The minimum length of the password to be generated (Default: 12)
- ```-x <length>```: The maximum length of the password to be generated (Default: 20) - ```-x <length>```: The maximum length of the password to be generated (Default: 20)