Pigeon-Ruby/README.md

1.1 KiB

Pigeon Ruby

A WIP pigeon protocol client.

How to Use

This is a pre-release skeleton project. There is no gem yet. The gem will be released after we are fully compliant with the spec and have high test coverage stats.

To get started, clone this repo and run ./pigeon-cli in place of pigeon.

Eg: pigeon identity show becomes ./pigeon-cli show.

Current Status

  • pigeon identity new
  • pigeon identity show
  • pigeon status
  • pigeon blob set
  • pigeon blob get
  • pigeon peer add
  • pigeon peer remove
  • pigeon peer block
  • pigeon peer all
  • Update spec to look like this
  • pigeon message new
  • pigeon message append
  • pigeon message current
  • pigeon message save
  • pigeon message find
  • pigeon message find-all
  • pigeon bundle create
  • pigeon bundle consume
  • 100% documentation
  • 100% coverage
  • add parsers and validators for all CLI inputs
  • Performance benchmarks
  • Performance tuning (DO THIS LAST!)