Skip to content

Commit

Permalink
Converted README from rdoc to textile
Browse files Browse the repository at this point in the history
  • Loading branch information
mbklein committed Jun 10, 2011
1 parent 5214020 commit dd1a188
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
23 changes: 12 additions & 11 deletions README.rdoc → README.textile
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
= pairtree
h1. pairtree

Ruby Pairtree implementation
Ruby implementation of the "Pairtree":https://confluence.ucop.edu/display/Curation/PairTree microservice specification from the California Digital Library

== Usage

h2. Usage

<pre><code>
# Initiate a tree
pt = Pairtree::Client.new('./data', :prefix => 'pfx:')
root = pt.root
pairtree = Pairtree.at('./data', :prefix => 'pfx:', :create => true)

# Create a ppath
obj = root.mk('pfx:abc123def')
obj = pairtree.mk('pfx:abc123def')

# Access an existing ppath
obj = root['pfx:abc123def']
obj = root.get('pfx:abc123def')
obj = pairtree['pfx:abc123def']
obj = pairtree.get('pfx:abc123def')

# ppaths are Dir instances with some File and Dir class methods mixed in
obj.read('content.xml')
Expand All @@ -27,9 +27,10 @@ Ruby Pairtree implementation
obj.unlink('my_file.txt')

# Delete a ppath and all its contents
root.purge!('pfx:abc123def')
pairtree.purge!('pfx:abc123def')
</code></pre>

== Copyright
h2. Copyright

Copyright (c) 2010 Chris Beer. See LICENSE.txt for
further details.
Expand Down
1 change: 1 addition & 0 deletions pairtree.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ Gem::Specification.new do |s|
s.add_development_dependency "rspec", ">= 2.0"
s.add_development_dependency "rcov", ">= 0"
s.add_development_dependency "yard"
s.add_development_dependency "RedCloth"
end

0 comments on commit dd1a188

Please sign in to comment.