README.md in localhost-1.1.5 vs README.md in localhost-1.1.6
- old
+ new
@@ -1,9 +1,12 @@
-# Localhost [![Build Status](https://travis-ci.com/socketry/localhost.svg)](https://travis-ci.com/socketry/localhost)
+# Localhost
This gem provides a convenient API for generating per-user self-signed root certificates.
+[![Build Status](https://travis-ci.com/socketry/localhost.svg)](https://travis-ci.com/socketry/localhost)
+[![Coverage Status](https://coveralls.io/repos/socketry/localhost/badge.svg)](https://coveralls.io/r/socketry/localhost)
+
## Motivation
HTTP/2 requires SSL in web browsers. If you want to use HTTP/2 for development (and you should), you need to start using URLs like `https://localhost:8080`. In most cases, this requires adding a self-signed certificate to your certificate store (e.g. Keychain on macOS), and storing the private key for the web-server to use.
I wanted to provide a server-agnostic way of doing this, primarily because I think it makes sense to minimise the amount of junky self-signed keys you add to your certificate store for `localhost`.
@@ -88,9 +91,13 @@
![Chrome](media/chrome.png)
- Click "ADVANCED" to see additional details, including...
- Click "Proceed to localhost (unsafe)" which will allow you to use the site for the current browser session.
+
+#### Self-Signed Localhost
+
+The best way to use Chrome with self-signed localhost certificates is to allow it in your chrome settings: [chrome://flags/#allow-insecure-localhost](chrome://flags/#allow-insecure-localhost).
### Files
The certificate and private key are stored in `~/.localhost/`. You can delete them and they will be regenerated. If you added the certificate to your keychain, you'll probably want to delete that too.