safety-pin 0.1.0 → 0.1.1

data/README.md

@@ -1,12 +1,16 @@
 # SafetyPin
 
-TODO: Write a gem description
+Interact with a [JCR Content Repository](http://jackrabbit.apache.org/jcr-api.html) using the Ruby code you love.
+
+Originally made to turn long, manually node editing tasks into fast, script-able moments.
 
 ## Installation
 
+**This gem requires [JRuby](http://jruby.org/) to run**
+
 Add this line to your application's Gemfile:
 
-    gem 'safety_pin'
+    gem 'safety-pin'
 
 And then execute:
 
@@ -14,11 +18,44 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install safety_pin
+    $ gem install safety-pin
 
 ## Usage
 
-TODO: Write usage instructions here
+You can interact with the JCR using Ruby code in ways you would expect:
+
+```ruby
+require 'safety-pin'
+include SafetyPin
+
+node = Node.find("/content") # returns node at path
+node.child("foo")            # returns child by name
+node.children                # returns array of children
+
+node.properties                    # returns hash of unprotected properties
+node.properties = {"bar" => "baz"} # replaces unprotected properties
+
+node["foo"]         # returns value of property
+node["foo"] = "bar" # assigns value to property
+
+node.save    # saves changes to session
+node.refresh # reloads node from JCR
+```
+
+## Interactive Shell
+
+You can open an IRB with SafetyPin included and connected to a JCR instance:
+
+```sh
+$ rbenv global jruby-1.7.0-rc1 # make sure to use JRuby
+$ gem install safety-pin
+$ safety-pin -h http://localhost:4502
+Username: # type username
+Password: # type password
+>> Node.find("/content")
+=> #<SafetyPin::Node:0x146ccf3e>
+>> # type whatever
+```
 
 ## Contributing
 

data/lib/safety_pin.rb

@@ -1,5 +1,7 @@
 $: << File.dirname(__FILE__)
 
+raise "Platform is #{RUBY_PLATFORM}, must be java. Please run using JRuby: http://jruby.org/" unless RUBY_PLATFORM == "java"
+
 require 'java'
 Dir.glob("**/*.jar").each {|jar| require jar }
 require 'safety_pin/jcr'

data/lib/safety_pin/version.rb

@@ -1,3 +1,3 @@
 module SafetyPin
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/safety-pin.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["jnraine@gmail.com"]
   gem.description   = %q{An easy-to-use JCR connector for JRuby}
   gem.summary       = %q{JCR connector for JRuby}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/jnraine/safety-pin"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safety-pin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -137,7 +137,7 @@ files:
 - spec/query_spec.rb
 - spec/spec_helper.rb
 - spec/where_condition_spec.rb
-homepage: ''
+homepage: https://github.com/jnraine/safety-pin
 licenses: []
 post_install_message: 
 rdoc_options: []