README.md in rpairtree-0.2.0 vs README.md in rpairtree-0.3.0
- old
+ new
@@ -1,14 +1,18 @@
-# (r)pairtree
+[![Tests](https://github.com/mlibrary/pairtree/actions/workflows/tests.yml/badge.svg)](https://github.com/mlibrary/pairtree/actions/workflows/tests.yml)
+[![Coverage Status](https://coveralls.io/repos/github/mlibrary/pairtree/badge.svg?branch=main)](https://coveralls.io/github/mlibrary/pairtree?branch=main)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
-Ruby implementation of the [Pairtree](https://wiki.ucop.edu/display/Curation/PairTree) specification from the California Digital Library.
+> :warning: Please use https://github.com/ruby-microservices/pairtree
+> It is now being maintained again, so there is no need for this separate fork.
+> `pairtree` 0.3.0 and `rpairtree` 0.3.0 are identical. This repository will be
+> archived, and there will be no further releases of `rpairtree`.
-## Description
+# rpairtree
-A fork of the seemingly-abandoned [pairtree](https://github.com/microservices/pairtree).
+Ruby implementation of the [Pairtree](https://www.ietf.org/archive/id/draft-kunze-pairtree-01.txt) specification from the California Digital Library.
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -24,10 +28,12 @@
$ gem install rpairtree
## Usage
```ruby
+ require 'pairtree'
+
# Initiate a tree
pairtree = Pairtree.at('./data', :prefix => 'pfx:', :create => true)
# Create a ppath
obj = pairtree.mk('pfx:abc123def')
@@ -49,6 +55,8 @@
# Delete a ppath and all its contents
pairtree.purge!('pfx:abc123def')
```
+## Copyright
+Copyright (c) 2010 Chris Beer. See LICENSE.txt for further details.