README.md in evervault-0.1.0 vs README.md in evervault-0.1.1
- old
+ new
@@ -1,14 +1,20 @@
# Evervault
+<p align="center">
+ <img src="res/logo.svg">
+</p>
-Ruby SDK for [Evervault](https://evervault.com)
+<p align="center">
+ <a href="https://github.com/evervault/evervault-ruby/actions?query=workflow%3Aevervault-unit-tests"><img alt="Evervault unit tests status" src="https://github.com/evervault/evervault-ruby/workflows/evervault-unit-tests/badge.svg"></a>
+</p>
-## Getting Started
+## Getting Started
+Ruby SDK for [Evervault](https://evervault.com)
### Prerequisites
-To get started with the Evervault Python SDK, you will need to have created a team on the evervault dashboard.
+To get started with the Evervault Ruby SDK, you will need to have created a team on the evervault dashboard.
We are currently in invite-only early access. You can apply for early access [here](https://evervault.com).
## Installation
@@ -53,11 +59,11 @@
result = evervault.encrypt_and_run(<CAGE-NAME>, { hello: 'World!' })
```
## API Reference
-### evervault.encrypt
+### Evervault.encrypt
Encrypt lets you encrypt data for use in any of your evervault cages. You can use it to store encrypted data to be used in a cage at another time.
```ruby
Evervault.encrypt(data = Hash | String)
@@ -65,11 +71,11 @@
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| data | Hash or String | Data to be encrypted |
-### evervault.run
+### Evervault.run
Run lets you invoke your evervault cages with a given payload.
```ruby
Evervault.run(cage_name = String, data = Hash)
@@ -78,11 +84,11 @@
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| cageName | String | Name of the cage to be run |
| data | Hash | Payload for the cage |
-### evervault.encryptAndRun
+### Evervault.encrypt_and_run
Encrypt your data and use it as the payload to invoke the cage.
```ruby
Evervault.encrypt_and_run(cage_name = String, data = Hash)
@@ -91,11 +97,11 @@
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| cageName | String | Name of the cage to be run |
| data | dict | Data to be encrypted |
-### evervault.cages
+### Evervault.cages
Return a hash of your team's Cage objects in hash format, with cage-name as keys
```ruby
Evervault.cages
@@ -119,10 +125,10 @@
@name="twilio-cage-explicit-salmon",
@request=#<Evervault::Http::Request:0x00007f8b900b7d40 @api_key="API-KEY", @base_url="https://api.evervault.com/", @cage_run_url="https://cage.run/", @timeout=30>,
@uuid="55986772-4db7-4695-ba44-1b807290ddea">}
```
-### evervault.cage_list
+### Evervault.cage_list
Return a `CageList` object, containing a list of your team's cages
```ruby
Evervault.cage_list