README.md in krypton-0.1.5 vs README.md in krypton-0.1.6

- old
+ new

@@ -1,6 +1,6 @@ -<p align="center"><img src="https://raw.githubusercontent.com/cbrnrd/krypton/master/img/krypton-readme-header.png"></p> +<p align="center"><img src="https://github.com/cbrnrd/krypton/raw/88b44a70de4829c3dd77dc8fbeb0395f89668b07/img/krypton-readme-header.png"></p> ## Installation You can install krypton as a standalone gem: @@ -11,13 +11,38 @@ $ gem install periodic-cli ## Usage -To encrypt a string, the command looks like this: +All krypton functions use the same basic syntax: `krypton [cmd] {[message/secret]{[key]}}` - $ krypton encrypt "mymessage" "mykey" - mymessage => ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg== +* `encrypt` - Encrypt a string + + $ krypton encrypt "mymessage" "mykey" + mymessage => ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg== + +* `decrypt` - Decrypt a string + + $ krypton decrypt "ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg" "mykey" + ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg => mymessage + +* `hash` - Hash a string or piped data + + $ krypton hash "mymessage" + mymessage => S3ONp9WM7/rCMeuUnvWDzp5dxbuSVsOV6bI5AJvRqCc= + + $ echo "mymessage" | krypton hash + mymessage => S3ONp9WM7/rCMeuUnvWDzp5dxbuSVsOV6bI5AJvRqCc= + +* `uuid` - Generate a secure [uuid](https://en.wikipedia.org/wiki/Universally_unique_identifier) + + $ krypton uuid + b6ff36d2-3f7e-4077-8ba5-5066f0a205a5 + +* `totp` - Generate a [time-based one-time password](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm) + + $ krypton totp "myawesomesecret" + myawesomesecret => 997820 ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/cbrnrd/krypton. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.