Skip to content
This repository was archived by the owner on Nov 18, 2022. It is now read-only.

Commit 40abcae

Browse files
committed
Updates readme
1 parent 268992d commit 40abcae

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@ EClet
22
=====
33

44
[![Build Status](https://travis-ci.org/cryptotronix/EClet.png)](https://travis-ci.org/cryptotronix/EClet)
5+
<a href="https://scan.coverity.com/projects/4781">
6+
<img alt="Coverity Scan Build Status"
7+
src="https://scan.coverity.com/projects/4781/badge.svg"/>
8+
</a>
59

610
Driver for the Cryptotronix EClet containing an Atmel ATECC108
711

812
Status
913
---
1014

11-
This software is in ***ALPHA***. I have tested the below commands, but some there are some features and documentation that I would like to finish. If you use this software, it will configure your ECC108 in a non-reversible way. It will allow you to sign and verify with P256 keys but future features may be incompatible.
15+
This software is in ***BETA***. I have tested the below commands, but some there are some features and documentation that I would like to finish. If you use this software, it will configure your ECC108 in a non-reversible way. It will allow you to sign and verify with P256 keys but future features may be incompatible.
1216

1317
You can following along with the release status [here](https://github.com/cryptotronix/EClet/issues?milestone=1&state=open).
1418

@@ -17,7 +21,7 @@ Building
1721

1822
This project uses Autotools.
1923

20-
It requires [libcrypti2c](https://github.com/cryptotronix/libcrypti2c), also in ***ALPHA***. If you use the [autogen](https://github.com/cryptotronix/EClet/blob/master/autogen.sh) script, it will automatically build and install the library.
24+
It requires [libcryptoauth-0.2](https://github.com/cryptotronix/libcrypti2c), also in ***ALPHA***. If you use the [autogen](https://github.com/cryptotronix/EClet/blob/master/autogen.sh) script, it will automatically build and install the library.
2125

2226
Hardware
2327
---
@@ -27,7 +31,16 @@ Product page will be available shortly. This software will also work on the [Cry
2731
Running
2832
---
2933

30-
see `./eclet --help` for full details. The default I2C bus is `/dev/i2c-1` and this can be changed with the `-b` option.
34+
see `./eclet --help` for full details. The default I2C bus is
35+
`/dev/i2c-1` and this can be changed with the `-b` option.
36+
37+
Kernel option
38+
---
39+
40+
If you build
41+
[libcryptoauth](https://github.com/cryptotronix/libcrypti2c) with the
42+
`-DUSE_KERNEL` flag and install the kernel module, this utility will
43+
use that module if you pass in: `-b /dev/atsha0`.
3144

3245
Root
3346
---
@@ -112,9 +125,4 @@ IRC: Join the `#cryptotronix` channel on freenode.
112125

113126
Mailing lists: `hashlet-announce` and `hashlet-users` are open for subscriptions [here](https://savannah.nongnu.org/mail/?group=hashlet).
114127

115-
Contributing
116-
---
117-
See the wiki page on [contributing](https://github.com/cryptotronix/hashlet/wiki/Contributing).
118-
119-
120128
![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)

0 commit comments

Comments
 (0)