PigeonProtocolConsortium/Pigeon-Ruby
PigeonProtocolConsortium
/
Pigeon-Ruby
3
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Add installation instructions

This commit is contained in:
Netscape Navigator 2020-06-09 08:21:22 -05:00
parent df09c37906
commit d17c5c64e9
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -19,20 +19,20 @@ Email `contact` at `vaporsoft.xyz` to ask questions or get involved. Your feedba
* Single threaded use is assumed. Built for a single user per OS process. Many design tradeoffs were made around that use case. * Single threaded use is assumed. Built for a single user per OS process. Many design tradeoffs were made around that use case.
* Bundling operations need performance tuning. Optimizations are planned and help is welcome. * Bundling operations need performance tuning. Optimizations are planned and help is welcome.
# Build From Source # Installation
We are not yet on Rubygems. The gem will be released after we are fully compliant with the spec. Add this to you Gemfile:
In the meantime:
``` ```
git clone https://tildegit.org/PigeonProtocolConsortium/pigeon_ruby.git gem "pigeon",
cd pigeon_ruby git: "https://tildegit.org/PigeonProtocolConsortium/pigeon_ruby",
gem build pigeon.gemspec tag: "v0.2.0"
gem install pigeon-0.1.1.gem ```
pigeon-cli identity new # Should work. Raise issue if not.
pigeon-cli status Then run
pigeon-cli help
```
bundle install
``` ```
# Usage: CLI # Usage: CLI
@ -72,9 +72,7 @@ See `kitchen_sink.sh` examples.
# Idea Bin # Idea Bin
- [ ] Ability to add map/reduce plugins to support custom indices? - [ ] Ability to add map/reduce plugins to support custom indices?
- [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe?
- [ ] Bundling via [Optar](http://ronja.twibright.com/optar/) or [Colorsafe](https://github.com/colorsafe/colorsafe) - [ ] Bundling via [Optar](http://ronja.twibright.com/optar/) or [Colorsafe](https://github.com/colorsafe/colorsafe)
- [ ] Ability to add map/reduce plugins to support custom indices? - [ ] Ability to add map/reduce plugins to support custom indices?
- [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe? - [ ] Ability to add a blob in one swoop using File objects and `Message#[]=`, maybe?
- [ ] Bundling via [Optar](http://ronja.twibright.com/optar/) or [Colorsafe](https://github.com/colorsafe/colorsafe) - [ ] Bundling via [Optar](http://ronja.twibright.com/optar/) or [Colorsafe](https://github.com/colorsafe/colorsafe)