README.md

Archangel

A Ruby client library and command-line interface for the Archangel DLT system.

Installation

Add this line to your application's Gemfile:

gem 'archangel'

And then execute:

$ bundle

Or install it yourself as:

$ gem install archangel

Usage

You can store and fetch data using the command-line client:

bundle exec archangel store {id} {payload}

bundle exec archangel fetch {id}

Currently this will store the payload string into Archangel (based on the ID and current time) using the dummy filesystem driver. A simple driver for Guardtime's Catena DB is also available. Future versions will support richer data and more backend drivers.

Commands:
  archangel store ID PAYLOAD  # stores PAYLOAD for ID at the current time
  archangel fetch ID          # retrieves the PAYLOAD previously stored with ID

Options:
  [--driver=DRIVER]      # Backend driver to use [file|guardtime]. Defaults to file
  [--username=USERNAME]  # Guardtime username
  [--password=PASSWORD]  # Guardtime password
  [--dir=DIR]            # File storage root directory

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/archangel-dlt/archangel-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Archangel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.