Skip to content

Commit 70f19a1

Browse files
authored
Cleanup the README installation section
1 parent 281c560 commit 70f19a1

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,27 @@ mkcert automatically creates and installs a local CA in the system root store, a
3030

3131
## Installation
3232

33-
On macOS, use [Homebrew](https://brew.sh/).
33+
> **Warning**: the `rootCA-key.pem` file that mkcert automatically generates gives complete power to intercept secure requests from your machine. Do not share it.
34+
35+
### macOS
36+
37+
On macOS, use [Homebrew](https://brew.sh/)
3438

3539
```
3640
brew install mkcert
3741
brew install nss # if you use Firefox
3842
```
3943

40-
Additionally on macOS, you can also use MacPorts.
44+
or MacPorts.
4145

4246
```
4347
sudo port sync
4448
sudo port install mkcert
4549
```
4650

47-
On Linux, install `certutil`
51+
### Linux
52+
53+
On Linux, first install `certutil`.
4854

4955
```
5056
sudo apt install libnss3-tools
@@ -53,34 +59,37 @@ sudo yum install nss-tools
5359
-or-
5460
sudo pacman -S nss
5561
```
56-
and install using [Linuxbrew](http://linuxbrew.sh/).
62+
63+
Then you can install using [Linuxbrew](http://linuxbrew.sh/)
5764

5865
```
5966
brew install mkcert
6067
````
6168
62-
You can also build from source (requires Go 1.10+), or use [the pre-built binaries](https://github.com/FiloSottile/mkcert/releases).
69+
or build from source (requires Go 1.10+)
6370
6471
```
6572
go get -u github.com/FiloSottile/mkcert
6673
$(go env GOPATH)/bin/mkcert
6774
```
6875
76+
or use [the pre-built binaries](https://github.com/FiloSottile/mkcert/releases).
77+
6978
On Arch Linux you can use your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) to install mkcert from the [PKGBUILD](https://aur.archlinux.org/packages/mkcert/).
7079
7180
```
7281
yaourt -S mkcert
7382
```
7483
75-
On Windows, use Chocolatey.
84+
### Windows
85+
86+
On Windows, use Chocolatey
7687
7788
```
7889
choco install mkcert
7990
```
8091
81-
Or build from source (requires Go 1.10+), or use [the pre-built binaries](https://github.com/FiloSottile/mkcert/releases).
82-
83-
> **Warning**: the `rootCA-key.pem` file that mkcert automatically generates gives complete power to intercept secure requests from your machine. Do not share it.
92+
or build from source (requires Go 1.10+), or use [the pre-built binaries](https://github.com/FiloSottile/mkcert/releases).
8493
8594
## Supported root stores
8695
@@ -89,8 +98,9 @@ mkcert supports the following root stores:
8998
* macOS system store
9099
* Windows system store
91100
* Linux variants that provide either
92-
* `update-ca-trust` (Fedora, RHEL, CentOS, Arch) or
93-
* `update-ca-certificates` (Ubuntu, Debian)
101+
* `update-ca-trust` (Fedora, RHEL, CentOS) or
102+
* `update-ca-certificates` (Ubuntu, Debian) or
103+
* `trust` (Arch)
94104
* Firefox (macOS and Linux only)
95105
* Chrome and Chromium
96106
* Java (when `JAVA_HOME` is set)

0 commit comments

Comments
 (0)