Skip to content

Commit

Permalink
docs: improved introduction section in the README
Browse files Browse the repository at this point in the history
Signed-off-by: blu3beri <berend@animo.id>
  • Loading branch information
berendsliedrecht committed Nov 21, 2022
1 parent aea0ecb commit 2dcc1e4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
</p>

<p align="center">
<a href="#introduction">Introduction</a>
&nbsp;|&nbsp;
<a href="#getting-started">Getting started</a>
&nbsp;|&nbsp;
<a href="#usage">Usage</a>
Expand All @@ -44,6 +46,16 @@

---

## Introduction

This package can be used as a transport for [DIDComm](https://didcomm.org) messages over Bluetooh Low Energy (BLE).
Before using this package, roles must be established. With BLE you have a "central" and "peripheral".
The peripheral advertises that it is able to connect with any central that is looking for the same unique identifier
(DIDComm UUIDs are defined here [didcomm bluetooth - identifiers](https://github.com/decentralized-identity/didcomm-bluetooth/blob/main/spec.md#identifiers)).
A central can then scan for any peripheral advertising the DIDComm service UUID. When the central finds the peripheral, it can connect and establish a connection.
Note that this does not establish a DIDComm connection, just the underlying BLE connection. After this, as defined in the examples below, the peripheral and central
can listen to incoming messages and send messages to the other participant.

## Getting Started

First, you need to add the dependency to your project:
Expand Down

0 comments on commit 2dcc1e4

Please sign in to comment.