= Paneron Register Ruby Gem

image:https://img.shields.io/gem/v/paneron-register.svg["Gem Version", link="https://rubygems.org/gems/paneron-register"] image:https://github.com/paneron/ruby-paneron-register/actions/workflows/test.yaml/badge.svg["Build Status",Link="https://github.com/paneron/ruby-paneron-register/actions/workflows/test.yaml"] image:https://codeclimate.com/github/paneron/ruby-paneron-register/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/paneron/ruby-paneron-register"] image:https://img.shields.io/github/issues-pr-raw/paneron/ruby-paneron-register.svg["Pull Requests", link="https://github.com/paneron/ruby-paneron-register/pulls"] image:https://img.shields.io/github/commits-since/paneron/ruby-paneron-register/latest.svg["Commits since latest",link="https://github.com/paneron/ruby-paneron-register/releases"]

== Installation

gem install paneron-register

== Usage

require "paneron/register"

# Initialize a new register
# This example uses a working copy of Paneron's register.
register = Paneron::Register::Register.new(
  "/Users/username/Library/Application Support/Electron/working_copies/00000000-0001-0000-0000-000000000001",
  "register_name-1"
)

# Alternatively, initialize a new register root:
root = Paneron::Register::RegisterRoot.new(
  "/Users/username/Library/Application Support/Electron/working_copies/00000000-0001-0000-0000-000000000001",
)
register = root.registries("register_name-1")

# Get all item class objects
register.item_classes

# Get a specific item class object
item_class = register.item_classes("item-class-1")

# Get all item class objects in Ruby Hash format
item_class.items_yamls

# Get a specific item property, using normal Ruby Hash methods
id = item_class.items_yamls["id"]
blob1 = item_class.items_yamls["data"]["blob1"]

== License

See LICENSE.txt