libves 1.0.4 → 2.0.1

package/README.md

@@ -1,15 +1,47 @@
 ## libVES
-A JavaScript interface to VESvault REST API (beta).
-libVES user WebCrypto end-to-end encryption.
+
+
+Simple, safe and secure e2e encryption for data at-rest.
+
 
 https://VESvault.com
+
 https://VES.host
 
-- Deposit and retrieve encrypted items into VESvault repository using end-to-end encryption
-- Manage asymmetric encryption keys in the VESvault repository using end-to-end encryption
-- [VESrecovery](https://www.vesvault.com/#vault)™ operations: set VESrecovery friends, assist in VESrecovery
 
-Run Makefile.pl to generate a consolidated js file, and a minified version of it.
+; Instantiate libVES
+
+var VES = new libVES({domain: 'x-myapp'});
+
+
+; Authorize with VES in the same browser window
+
+VES.flow(true).then(....)
+
+
+; Or, authorize in a popup window
+
+VES.delegate().then(....)
+
+
+; Store an e2e encrypted value
+
+VES.putValue('item-id', 'value')
+
+
+; Store a value and e2e share with other VES accounts
+
+VES.putValue('item-id', 'value', [{externalId: 'me@acme.com'}, {externalId: 'user1@acme.com'}, {externalId: 'user2@acme.com'}])
+
+
+; Retrieve a previously stored value
+
+VES.getValue('item-id').then(function(value) { .... })
+
+
+See https://demo.ves.world
+
+
+Full API Docs:
 
-API Documentation:
 https://ves.host/docs/libVES