Skip to content

Commit

Permalink
Update installation and usage infomation
Browse files Browse the repository at this point in the history
  • Loading branch information
colinodell committed Dec 31, 2021
1 parent 67009da commit 1a1ce26
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@ Simple command line utility to check the status of an SSL certificate.

Basically, it attempts to establish a TLS connection to a server and reports back useful info about the cert's status.

## Usage
## Installation

To install the utility, please [download the appropriate release](https://github.com/colinodell/go-check-ssl/releases), unarchive the files, and move the binary somewhere under your path.
To upgrade, download the latest version and replace the binary with the new one.

Either build it yourself or grab a pre-compiled download from the [Releases](https://github.com/colinodell/go-check-ssl/releases) page.
On macOS, you can use homebrew: `brew install colinodell/tap/check-ssl`

## Usage

To check a certificate, simply run:

```bash
./check-ssl [server]
check-ssl [server]
```

![](screenshot.png)
Expand All @@ -26,7 +31,7 @@ Example of allowed arguments include:
By default, it'll resolve the IP of the given domain and test against that server. But you can also use this tool to check other servers by providing two arguments: the server to test and the SNI to use. For example:

```bash
./check-ssl [server] --sni=[SNI domain]
check-ssl [server] --sni=[SNI domain]

./check-ssl example.com --sni=foo.example.com
check-ssl example.com --sni=foo.example.com
```

0 comments on commit 1a1ce26

Please sign in to comment.