cryptic 1.0.0.beta.1 → 1.0.0.beta.2

data/README.md

@@ -1,29 +1,45 @@
-# Public Key Encryption/Decryption
-
-TODO: Write a gem description
+# Cryptic
+A Ruby gem for public key encryption, private key decryption, and generating key pairs.
 
 ## Installation
+Just run: `gem install cryptic` or add `gem 'cryptic'` to your Gemfile.
 
-Add this line to your application's Gemfile:
-
-    gem 'cryptic'
+## Usage
+### Command line
 
-And then execute:
+```
+[ecarey @ cryptic]$ cryptic 
+Commands:
+  cryptic decrypt [PRIVATE_KEY] [ENCRYPTED_FILE] [OPTIONS]  # Decrypt a file with a private key
+  cryptic encrypt [PUBLIC_KEY] [TEXT_FILE] [OPTIONS]        # Encrypt a file with a public key
+  cryptic generate [OPTIONS]                                # Generate a private/public keypair
+  cryptic help [COMMAND]                                    # Describe available commands or one specific command
+```
 
-    $ bundle
+### Ruby
 
-Or install it yourself as:
+```ruby
+# Generate a keypair to use with a passphrase and the number of bits you'd like:
+keypair = Cryptic::Keypair.new('P4$SpHr4z3', 2048)
+keypair.save("#{ENV['HOME']}/.cryptic_keys")
 
-    $ gem install cryptic
+private_key = keypair.private_key
+public_key = keypair.public_key
 
-## Usage
+# Encrypt a file:
+data = File.read('foo.txt')
+encrypted = Cryptic::EncryptedData.new(data, public_key)
 
-TODO: Write usage instructions here
+# Returns an encrypted string you can save off to a file
+encrypted.data
 
+# To return the data call decrypt on the encrypted data object w/ the private key and passphrase
+decrypted = encrypted.decrypt(private_key, 'P4$SpHr4z3')
+```
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b feature/my-awesome-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin feature/my-awesome-feature`)
 5. Create new Pull Request

data/cryptic.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'colorize'
   spec.add_dependency 'redcarpet'
   spec.add_dependency 'thor'
   spec.add_dependency 'yard'

data/lib/cryptic/version.rb

@@ -1,4 +1,4 @@
 module Cryptic
   # The version of the cryptic gem
-  VERSION = '1.0.0.beta.1'
+  VERSION = '1.0.0.beta.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cryptic
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.1
+  version: 1.0.0.beta.2
   prerelease: 6
 platform: ruby
 authors:
@@ -11,6 +11,22 @@ bindir: bin
 cert_chain: []
 date: 2013-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1237837409677303508
+      hash: 3581446643865298365
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: