From 433a99275506bfdd0ed9efbf8392320f8d19fdcf Mon Sep 17 00:00:00 2001 From: Mariia Malitska <37335222+MariiaMalitska@users.noreply.github.com> Date: Wed, 19 Jun 2019 17:02:15 +0300 Subject: [PATCH] Update README.md Minor fixes --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3fe896f6..056ae324 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Virgil E3kit allows you to setup user encryption with multidevice support in jus - group chats - manage users' Public Keys -## Install E3Kit SDK +## Installation You can install E3Kit SDK using [Gradle](https://gradle.org/). Please, choose package that suits best for your needs: @@ -24,10 +24,12 @@ You can install E3Kit SDK using [Gradle](https://gradle.org/). Please, choose pa | [`E3Kit`](./ethree-kotlin) | Standard package for Java/Kotlin with methods responses in `callbacks` | -## Usage +## Usage Examples #### Initialize e3kit +In order to interact with the Virgil Cloud, the Virgil e3kit SDK must be provided with a callback that it will call to fetch the Virgil JWT from your backend for the current user. + ```kotlin lateinit var eThree: EThree @@ -49,7 +51,9 @@ EThree.initialize(context, virgilTokenCallback).addCallback(initializeListener) ``` #### Register user + Use the following lines of code to register a user: + ```kotlin // TODO: Initialize e3kit @@ -99,6 +103,8 @@ eThree.lookupPublicKeys(listOf("userUID1", "userUID2", "userUID3")).addCallback( #### Decrypt data/text and verify signature +This method decrypts the data using the recipient's private key and verifies authenticity of the decrypted data with sender's public key. + ```kotlin // TODO: Initialize e3kit, Register e3kit user