v0.0.4 doc updates

This commit is contained in:
Netscape Navigator 2020-04-18 13:18:00 -05:00
parent db1f05a8af
commit cc12b91d53
4 changed files with 11 additions and 8 deletions

1
.gitignore vendored
View File

@ -4,3 +4,4 @@ coverage/
doc/ doc/
*scratchpad* *scratchpad*
pigeon.bundle pigeon.bundle
*.gem

View File

@ -6,23 +6,24 @@ This is a WIP [Pigeon Protocol] client written in Ruby.
# Installation # Installation
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. We are not yet on Rubygems. The gem will be released after we are fully compliant with the spec and have high test coverage stats.
In the meantime: In the meantime:
``` ```
git clone https://tildegit.org/PigeonProtocolConsortium/pigeon_ruby.git git clone https://tildegit.org/PigeonProtocolConsortium/pigeon_ruby.git
cd pigeon_ruby cd pigeon_ruby
bundle install gem build pigeon.gemspec
./pigeon-cli # Should work. Raise issue if not. gem install pigeon-0.0.4.gem
pigeon-cli identity new # Should work. Raise issue if not.
pigeon-cli status
pigeon-cli help
``` ```
# Usage: CLI # Usage: CLI
We provide a CLI wrapper as `pigeon-cli`. See `pigeon-cli help` for documentation.
Help is provided by running `./pigeon-cli`. See `kitchen_sink.sh` examples.
See `kitchen_sink.sh` for an example of all commands.
# Usage: Ruby Lib # Usage: Ruby Lib

View File

@ -7,7 +7,8 @@ def db
if File.file?(Pigeon::PIGEON_DB_PATH) if File.file?(Pigeon::PIGEON_DB_PATH)
$db ||= Pigeon::Database.new $db ||= Pigeon::Database.new
else else
raise "ERROR: You need to create a database file first." STDERR.puts("You must first run `pigeon-cli identity new`.")
exit 1
end end
end end

Binary file not shown.