v0.0.4 doc updates
This commit is contained in:
parent
db1f05a8af
commit
cc12b91d53
|
@ -4,3 +4,4 @@ coverage/
|
||||||
doc/
|
doc/
|
||||||
*scratchpad*
|
*scratchpad*
|
||||||
pigeon.bundle
|
pigeon.bundle
|
||||||
|
*.gem
|
||||||
|
|
15
README.md
15
README.md
|
@ -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
|
||||||
|
|
||||||
|
|
|
@ -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
|
||||||
|
|
||||||
|
|
BIN
pigeon-0.0.4.gem
BIN
pigeon-0.0.4.gem
Binary file not shown.
Loading…
Reference in New Issue