Verified Commit f27fecd9 authored by Aral Balkan's avatar Aral Balkan
Browse files

Update documentation

parent 50fd195a
......@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [2.0.2] - 2020-07-10
### Fixed
- Links to developer documentation now work everywhere, not just on source code repository web interfaces.
### Changed
- Replaced outdated coverage message in readme and linked to developer documentation for information on tests and coverage.
## [2.0.1] - 2020-07-03
### Added
......
......@@ -104,7 +104,7 @@ When you’re ready to exit your app, just call the `server.close()` method as y
## Developer documentation
If you want to help improve Auto Encrypt or better understand how it is structured and operates, please see the [developer documentation](developer-documentation.md).
If you want to help improve Auto Encrypt or better understand how it is structured and operates, please see the [developer documentation](https://github.com/small-tech/auto-encrypt/blob/master/developer-documentation.md).
## Examples
......@@ -217,11 +217,13 @@ A drop-in [standard Node.js HTTPS module](https://nodejs.org/dist/latest-v12.x/d
A complete [small technology](https://small-tech.org/about/#small-technology) tool for developing, testing, and deploying a secure static or dynamic personal web site or app with zero configuration.
## Coverage
## Tests and coverage
__The tests are currently broken and in the process of being overhauled following some major development work.__
This project aims for > 80% coverage. At a recent check, coverage was at 95.29% (statements), 82.69% (branch), 95.19% (functions), 95.68% (lines).
(For the latest state, run `npm run coverage`)
To see the current state of code coverage, run `npm run coverage`.
For more details, please see the [developer documentation](https://github.com/small-tech/auto-encrypt/blob/master/developer-documentation.md#tests).
## A note on Linux and the security farce that is “privileged ports”
......
{
"name": "@small-tech/auto-encrypt",
"version": "2.0.1",
"version": "2.0.2",
"description": "Adds automatic provisioning and renewal of Let’s Encrypt TLS certificates with OCSP Stapling to Node.js https servers (including Express.js, etc.)",
"keywords": [
"let's encrypt",
......
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