libves 1.0.3 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,15 +1,34 @@
1
1
  ## libVES
2
- A JavaScript interface to VESvault REST API (beta).
3
- libVES user WebCrypto end-to-end encryption.
2
+
3
+
4
+ Simple, safe and secure e2e encryption for data at-rest.
5
+
4
6
 
5
7
  https://VESvault.com
6
8
  https://VES.host
7
9
 
8
- - Deposit and retrieve encrypted items into VESvault repository using end-to-end encryption
9
- - Manage asymmetric encryption keys in the VESvault repository using end-to-end encryption
10
- - [VESrecovery](https://www.vesvault.com/#vault)™ operations: set VESrecovery friends, assist in VESrecovery
11
10
 
12
- Run Makefile.pl to generate a consolidated js file, and a minified version of it.
11
+ ; Instantiate libVES
12
+ var VES = new libVES({domain: 'x-myapp'});
13
+
14
+ ; Authorize with VES in the same browser window
15
+ VES.flow(true).then(....)
16
+
17
+ ; Or, authorize in a popup window
18
+ VES.delegate().then(....)
19
+
20
+ ; Store an e2e encrypted value
21
+ VES.putValue('item-id', 'value')
22
+
23
+ ; Store a value and e2e share with other VES accounts
24
+ VES.putValue('item-id', 'value', [{externalId: 'me@acme.com'}, {externalId: 'user1@acme.com'}, {externalId: 'user2@acme.com'}])
25
+
26
+ ; Retrieve a previously stored value
27
+ VES.getValue('item-id').then(function(value) { .... })
28
+
29
+
30
+ See https://demo.ves.world
31
+
13
32
 
14
- API Documentation:
33
+ Full API Docs:
15
34
  https://ves.host/docs/libVES