README.md in krypter-1.0.0 vs README.md in krypter-1.0.1

- old
+ new

@@ -1,10 +1,31 @@ -krypter +Krypter [![Build Status](https://travis-ci.org/frodsan/krypter.svg)](https://travis-ci.org/frodsan/krypter) ======= Encrypts messages with authentication. +Installation +------------ + +Add this line to your application's Gemfile: + +```ruby +gem "krypter" +``` + +And then execute: + +``` +$ bundle +``` + +Or install it yourself as: + +``` +$ gem install krypter +``` + Usage ----- Pass a secret token. This must be at least 32 bytes long and should be really random. You can generate @@ -37,18 +58,42 @@ to prevent tampering and chosen ciphertext attacks. The defaults can be changed when instantiating the encryptor object. ```ruby -encryptor = Encryptor.new(secret, +encryptor = Krypter.new(secret, cipher: "aes-256-cbc", digest: "SHA256", separator: "--" ) ``` -Installation +Contributing ------------ +Fork the project with: + ``` -$ gem install krypter +$ git clone git@gitlab.com:frodsan/krypter.git ``` + +To install dependencies, use: + +``` +$ bundle install +``` + +To run the test suite, do: + +``` +$ rake test +``` + +For bug reports and pull requests, use [GitLab][issues]. + +License +------- + +Krypter is released under the [MIT License][mit]. + +[mit]: http://www.opensource.org/licenses/MIT +[issues]: https://gitlab.com/frodsan/krypter/issues