Skip to content

Commit 07a2b56

Browse files
committed
Add NervesHub doc link; minor edits
1 parent 271690f commit 07a2b56

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
The NervesKey is a configured [ATECC508A or ATECC608A Crypto
77
Authentication](https://www.microchip.com/wwwproducts/en/ATECC508A) chip that's
88
used for authenticating devices with NervesHub and other cloud services. At a
9-
high level, it is simple HSM that protects one private key by requiring all
10-
operations on that key to occur inside chip. The project provides access to the
11-
chip from Elixir and makes configuration decisions to make working with the
12-
device easier. It has the following features:
9+
high level, it is a simple hardware security module (HSM) that protects one
10+
private key by requiring all operations on that key to occur inside chip. The
11+
project provides access to the chip from Elixir and makes configuration
12+
decisions to make working with the device easier. It has the following features:
1313

1414
1. Provision blank ATECC508A/608A devices - this includes private key generation
1515
2. Storage for serial number and one-time calibration data (useful if primary
@@ -28,6 +28,9 @@ ATECC508A/608A during the provisioning process. This is a feature and is
2828
required for normal operation, but if you're getting started, make sure that you
2929
have a few extra parts just in case.
3030

31+
See [NervesHub documentation](https://docs.nerves-hub.org/) for end-user
32+
NervesKey and NervesHub documentation.
33+
3134
See [hw/hw.md](hw/hw.md) for information on pre-built hardware modules.
3235

3336
## Installation

hw/hw.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,4 @@ details, notes, and examples.
3535
* [Microchip's ATECC608A](https://www.microchip.com/wwwproducts/en/ATECC608A)
3636
website
3737
* [cryptoauthlib](https://github.com/MicrochipTech/cryptoauthlib) - a different,
38-
but official C library for the ATECC508A/608A
39-
38+
but official C library for the ATECC508A/608A

0 commit comments

Comments
 (0)