Update readme to reflect the current state of the app

parent f78e81a4
......@@ -4,7 +4,7 @@ An HTTPS server that uses [nodecert](https://source.ind.ie/hypha/tools/nodecert)
## Design goals
*__Command-line use:__ https-server _directory_
* ✔ Command-line app
* To-do: Easy integration into Express
* To-do: Seamless switch to using ACME/Let’s Encrypt in production
......@@ -14,8 +14,6 @@ An HTTPS server that uses [nodecert](https://source.ind.ie/hypha/tools/nodecert)
npm i -g @ind.ie/https-server
```
(On macOS, you must [manually install the dependency](#macos-dependency) for now.)
## Note regarding port 443
The server is started on port 443 by default. This is on purpose as an overarching goal of https-server is to make your development environment mirror your production environment as closely possible to remove that complexity from the code you have to write.
......@@ -51,20 +49,9 @@ Both arguments are optional. Currently, if you want to specify the port manually
* `[folder-to-serve]` defaults to `.` (the current directory)
* `[port]` defaults to 443. (See [note regarding port 443](#note-regarding-port-443), above.)
If you do not already have TLS certificates, they will be created for you automatically using nodecert.
On Linux, all dependencies will be installed automatically for you if they do not exist (only tested with apt).
For macOS, see the note on manually installing the macOS dependency, below.
## macOS dependency
On macOS, you must currently install a mkcert dependency manually:
For your certificate to work in Firefox:
If you do not already have TLS certificates, they will be created for you automatically using [nodecert](https://source.ind.ie/hypha/tools/nodecert).
* [Homebrew](https://brew.sh/): `brew install nss`
* [MacPorts](https://www.macports.org/): `sudo port install install nss`
All dependencies will be installed automatically for you if they do not exist if you have apt, yum (untested), or pacman (untested) on Linux or if you have [Homebrew](https://brew.sh/) or [MacPorts](https://www.macports.org/) (untested) on macOS.
## Help wanted
......@@ -73,6 +60,6 @@ I’ve currently only tested this on Pop!_OS 18.10 (Ubuntu-based distro). I can
* Windows 64-bit (should work without requiring any dependencies)
* Linux with yum
* Linux with pacman
* macOS (I will be looking at this next)
* macOS with MacPorts
If you get a chance to try out https-server on the above platforms, please [let me know how/if it works](https://github.com/indie-mirror/https-server/issues). Thank you.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment