diff --git a/README.md b/README.md index db5bc3de..51ee40e3 100644 --- a/README.md +++ b/README.md @@ -501,6 +501,8 @@ Please use **box.openSpace** to get the instance of this class * [.addGithub(gistUrl)](#Verified+addGithub) ⇒ Object * [.twitter()](#Verified+twitter) ⇒ Object * [.addTwitter(claim)](#Verified+addTwitter) ⇒ Object + * [.email()](#Verified+email) ⇒ Object + * [.addEmail(claim)](#Verified+addEmail) ⇒ Object @@ -556,3 +558,24 @@ Throws an error if the verification fails. | --- | --- | --- | | claim | String | A did-JWT claim ownership of a twitter username | + + +#### verified.email() ⇒ Object +Verifies that the user has a verified email account +Throws an error otherwise. + +**Kind**: instance method of [Verified](#Verified) +**Returns**: Object - Object containing username, proof, and the verifier + + +#### verified.addEmail(claim) ⇒ Object +Adds an email verification to the users profile +Throws an error if the verification fails. + +**Kind**: instance method of [Verified](#Verified) +**Returns**: Object - Object containing username, proof, and the verifier + +| Param | Type | Description | +| --- | --- | --- | +| claim | String | A did-JWT claim ownership of an email username | + diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 7b3fd4e0..66b56f59 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,5 +1,8 @@ # Release Notes +## v1.4.0 - 2019-02-21 +* New functions for adding a verified email credential + ## v1.3.0 - 2019-02-05 * Spaces feature, allows dapps to request access to compartments of the users 3Box which only dapps which the user has given explicit permission to can read/write * 3Box is now able to run completely offline diff --git a/package.json b/package.json index 46a9d550..fbb5474b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "3box", - "version": "1.3.0", + "version": "1.4.0", "description": "Interact with user data", "main": "lib/3box.js", "directories": {