Pigeon-Ruby/README.md

38 lines
1.1 KiB
Markdown
Raw Normal View History

2019-09-22 02:30:03 +00:00
# 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
- [X] pigeon identity new
- [X] pigeon identity show
- [X] pigeon status
2019-09-22 02:31:01 +00:00
- [X] pigeon blob set
2019-09-22 11:00:19 +00:00
- [X] pigeon blob get
- [X] pigeon peer add
- [X] pigeon peer remove
- [X] pigeon peer block
2019-09-25 01:31:32 +00:00
- [X] pigeon peer all
2019-10-06 17:57:55 +00:00
- [ ] Update spec to look [like this](https://gist.github.com/RickCarlino/3ff4178db4a75fd135832c403cd313d4)
2019-09-23 01:09:04 +00:00
- [ ] pigeon message new
- [ ] pigeon message append
2019-10-06 17:57:55 +00:00
- [ ] pigeon message current
2019-09-23 01:09:04 +00:00
- [ ] 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
2019-09-25 01:31:32 +00:00
- [ ] Performance benchmarks
- [ ] Performance tuning (DO THIS LAST!)