Skip to content
This repository has been archived by the owner on Mar 16, 2020. It is now read-only.

Add secrets sharing documentation #3

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 32 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,52 @@
# Kumo Ki
Kumo Ki
=======

Gem for accessing secrets in Amazon's Key Management Service
Gem for accessing secrets in Amazon's Key Management Service.

## Installation
Installation
------------

Add this line to your application's Gemfile:

```ruby
gem 'kumo_ki'
gem 'kumo_ki', '~> 1.0' # see semver.org
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install kumo_ki

## Usage
Usage
-----

```ruby
require 'kumo_ki'

# Encrypt a secret for a given environment
cipher_text = KumoKi::KMS.new.encrypt_for('my_staging_environment', 'supersecretkeyoooh')

# Decrypt the secret in that environment
puts KumoKi::KMS.new.decrypt(cipher_text)
```

## Contributing
Contributing
------------

1. Fork it ( https://github.com/[my-github-username]/kumo_ki_gem/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

Credits
-------

[![](doc/redbubble.png)][redbubble]

Kumo Ki is maintained and funded by [Redbubble][redbubble].

[redbubble]: https://www.redbubble.com

License
-------

Kumo Ki
Copyright (C) 2016 Redbubble

All rights reserved.
Binary file added doc/redbubble.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.