From 91eeeddf4490ba6e9dc8274db2dfe30b13e628a5 Mon Sep 17 00:00:00 2001
From: Geovane Fedrecheski <geonnave@gmail.com>
Date: Mon, 26 Feb 2024 14:30:45 +0100
Subject: [PATCH] chore: update readme

---
 README.md | 44 +++++++++++++++++++++++++++++++++-----------
 1 file changed, 33 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 290e16fc..71899651 100644
--- a/README.md
+++ b/README.md
@@ -2,20 +2,41 @@
 
 [![Build and test](https://github.com/openwsn-berkeley/lakers/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/openwsn-berkeley/lakers/actions/workflows/build-and-test.yml)
 
-A microcontroller-optimized implementation of EDHOC in Rust (`no_std`, static memory).
+An implementation of [EDHOC](https://datatracker.ietf.org/doc/draft-ietf-lake-edhoc/) in Rust:
+- up-to-date with the [latest draft version (23)](https://datatracker.ietf.org/doc/draft-ietf-lake-edhoc/23/)
+- microcontroller-optimized: `no_std`, no heap allocations, zero-dependencies (other than crypto backends)
+- configurable crypto backends
+- bindings for [C](https://github.com/openwsn-berkeley/lakers/releases/) and [Python](https://pypi.org/project/lakers-python/)
+- support for EDHOC extensions, including [zero-touch authorization](https://datatracker.ietf.org/doc/draft-ietf-lake-authz/)
 
-`lakers` provides an implementation of the following drafts produced by the [Lightweight Authenticated Key Exchange (LAKE)](https://datatracker.ietf.org/wg/lake/about/) working group at the IETF:
+It currently supports authentication mode STAT-STAT and Cipher Suite 2 (AES-CCM-16-64-128, SHA-256, 8, P-256, ES256, AES-CCM-16-64-128, SHA-256).
 
-- [Ephemeral Diffie-Hellman Over COSE (EDHOC)](https://datatracker.ietf.org/doc/draft-ietf-lake-edhoc/)
-- [Lightweight Authorization using EDHOC](https://datatracker.ietf.org/doc/draft-ietf-lake-authz/)
+Here's a quick look at the API for the Initiator role (for the Responder role, and more details, check the examples or the unit tests):
+```rust
+let initiator = EdhocInitiator::new(default_crypto());
 
-It supports:
-* Roles: Initiator, Responder
-* Authentication mode: STAT-STAT
-* Cipher suite: 2 (AES-CCM-16-64-128, SHA-256, 8, P-256, ES256, AES-CCM-16-64-128, SHA-256)
+let (initiator, message_1) = initiator.prepare_message_1(None, &None)?; // c_i and ead_1 are set to None
+
+let (initiator, _c_r, id_cred_r, _ead_2) = initiator.parse_message_2(&message_2)?;
+let valid_cred_r = credential_check_or_fetch(Some(CRED_R), id_cred_r)?; // CRED_R contains Responder's public key
+let initiator = initiator.verify_message_2(I, cred_i, valid_cred_r)?; // I is Initiator's private key
+
+let (mut initiator, message_3, i_prk_out) = initiator.prepare_message_3(CredentialTransfer::ByReference, &None)?; // no ead_3
+```
 
 ## Installation
 
+To use `lakers` in your Rust project, simply add it to your Cargo.toml: `lakers = "0.5.0"` (check for the [latest version here](https://crates.io/crates/lakers)).
+
+### C API
+C-compatible static libraries and headers are available for download in [the releases page](https://github.com/openwsn-berkeley/lakers/releases).
+
+### Python API
+`lakers-python` is [available on PyPI](https://pypi.org/project/lakers-python/), to install it run `pip install lakers-python`.
+
+### Development
+To work on `lakers` itself, follow the instructions below:
+
 1. Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed.
 
 2. Download, compile, and run the tests:
@@ -59,9 +80,9 @@ cargo build --target="thumbv7em-none-eabihf" --no-default-features --features="c
 
 ```
 
-To build **and** flash to the board, replace the word `build` with `embed` in the commands above (you may need to `cargo install cargo-embed`).
-
-For example: `cargo embed --target="thumbv7em-none-eabihf" --no-default-features --features="crypto-psa, ead-none, rtt"`
+To build **and** flash to the board:
+1. install [cargo-embed](https://crates.io/crates/cargo-embed)
+1. run one of the commands above, but use the command `embed` in place of `build`. For example: `cargo embed --target="thumbv7em-none-eabihf"`
 
 ## Directory structure
 This library is structured as a [cargo workspace](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html).
@@ -72,4 +93,5 @@ Its main members are:
 - `ead`: Implementation of extensions to EDHOC via the External Authorization Data (EAD) field.
 - `shared`: Defines shared structs and modules used throughout the workspace members.
 - `lakers-c`: Provides a foreign function interface that enables using `lakers` from C code.
+- `lakers-python`: API for using `lakers` in Python.
 - `examples`: Example applications that demonstrate how to use the library.