Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aral committed Jul 10, 2020
1 parent 50fd195 commit f27fecd
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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”

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"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",
Expand Down

0 comments on commit f27fecd

Please sign in to comment.