README.md in voltos-0.3.0 vs README.md in voltos-0.3.2
- old
+ new
@@ -1,107 +1,74 @@
# Voltos Ruby bindings
-This gem provides Voltos Ruby bindings to access the Voltos API from apps written in Ruby. Voltos ([https://voltos.online](https://voltos.online)) provides credentials-as-a-service for app and system developers.
+This gem provides Voltos Ruby bindings to access the Voltos API from apps written in Ruby. Voltos ([https://voltos.io](https://voltos.io)) provides credentials-as-a-service for app and system developers.
-Voltos stores your credentials (e.g. API keys, usernames, passwords, tokens) in a secure, central location - so that your apps can access them, and you can more easily manage them & access to them.
+Voltos stores your credentials (e.g. API keys, usernames, passwords, tokens) in a secure, central location - so that your apps can access them securely as environment variables, and you can more easily manage & access them.
## Contents
* [Installation](#installation)
-* [Getting started](#getting-started)
+* [Using Voltos](#using-voltos)
+* [Deploying to Heroku](#deploying-to-heroku)
+* [Contributing](#contributing)
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'voltos', '~> 0.3.0rc14'
+gem 'voltos'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install voltos
-
+
### Troubleshooting installation
**Ubuntu**
You may need to install native extensions first:
-```
-sudo apt-get install libcurl4-openssl-dev
-```
-## Getting started
+ $ sudo apt-get install libcurl4-openssl-dev
-### Sign up
-```
-$ voltos signup
-```
+## Using Voltos
+Using Voltos to manage your credentials and secrets is generally the same across all platforms. Check out the general docs at:
-### Sign in
-```
-$ voltos auth
-```
+* [Getting started](https://github.com/gluio/voltos-docs/blob/master/README.md#getting-started)
+* [Using Voltos with your apps](https://github.com/gluio/voltos-docs/blob/master/README.md#using-voltos-with-your-apps)
-### Create bundle of credentials
-```
-$ voltos create piedpiper-backend
-```
-### Add credentials to bundle
-```
-## add to default bundle in use
-$ voltos set MAILSERVICE=17263ed6547a7c7d8372
-$ voltos set DEV_URL=https://dev.piedpiper.io
+## Deploying to Heroku
+Ensure your Heroku app is packaging the `voltos` gem in your Gemfile.
-## or explicitly specify which bundle:
-$ voltos set MAILSERVICE=17263ed6547a7c7d8372 piedpiper-backend
-$ voltos set DEV_URL=https://dev.piedpiper.io piedpiper-backend
-```
+Update your `Procfile` to run your process using `voltos`
-### List credentials in a bundle
-```
-$ voltos list
-```
+ web: voltos run "puma -C config/puma.rb"
-### List all bundles of credentials that you can access
-```
-$ voltos list --all
-```
+Manually retrieve the API token for the selected bundle
-### Share bundle of credentials
-```
-$ voltos share sasha@hooli.com
-```
+ $ voltos use your-voltos-bundle
+ Setting current bundle in use to 'your-voltos-bundle'... ⣻
-### Unshare bundle of credentials
-```
-$ voltos retract piedpiper-backend sasha@hooli.com
-```
+ $ voltos token
+ Fetching token... ⣻
-### Remove credentials
-```
-$ voltos unset piedpiper-backend DEV_URL
-```
+ New API token for 'your-voltos-bundle' is: cbff7be5112287c39dad41c643761a84
+ Please store this securely, this is the only time it will be displayed and it can not be retrieved again
+ (though you can request a new one)
-### Destroy bundle of credentials
-```
-$ voltos destroy piedpiper-backend
-```
+Then add the API token to the Heroku config variables for your app
+ $ heroku config:set VOLTOS_KEY=cbff7be5112287c39dad41c643761a84
-## Using Voltos with your apps
+On startup, `voltos` will securely retrieve your bundle's credentials and make them available to your app.
-When you're done loading up your bundles with credentials, you'll want to start using them with your apps.
+Anytime you need to update your credentials: do so via the CLI or web app, `heroku restart` your app, and the updated credentials are loaded up to your app again.
-### Running locally
-
-### Deploying to Heroku
-
-
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/voltos-online/voltos-ruby
+Bug reports and pull requests are welcome on GitHub at https://github.com/gluio/voltos-ruby