spejamchr/sia

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Sia

[![Gem Version](https://badge.fury.io/rb/sia.svg)](
https://badge.fury.io/rb/sia)
[![CircleCI](https://circleci.com/gh/spejamchr/sia.svg?style=shield)](
https://circleci.com/gh/spejamchr/sia)
[![Maintainability](https://api.codeclimate.com/v1/badges/75cf5916519ae7729bd0/maintainability)](
https://codeclimate.com/github/spejamchr/sia/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/75cf5916519ae7729bd0/test_coverage)](
https://codeclimate.com/github/spejamchr/sia/test_coverage)
[![GitHub](https://img.shields.io/badge/github-spejamchr/sia-blue.svg)](
https://github.com/spejamchr/sia)
[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](
https://www.rubydoc.info/gems/sia)

Encrypt files by storing them in digital safes. Each safe has a name and a
password and can store as many files as you want.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'sia'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install sia

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake spec` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To
release a new version, update the version number in `version.rb`, and then run
`bundle exec rake release`, which will create a git tag for the version, push
git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/spejamchr/sia.

## License

The gem is available as open source under the terms of the [MIT
License](https://opensource.org/licenses/MIT).