47 lines
890 B
Plaintext
47 lines
890 B
Plaintext
|
Knot
|
||
|
|
====
|
||
|
|
|
||
|
|
Implements the knot-protocol.
|
||
|
|
It is possible to write a knot-cli like knotc in ruby.
|
||
|
|
Or your own tool, for provisioning.
|
||
|
|
|
||
|
|
Installation
|
||
|
|
============
|
||
|
|
|
||
|
|
Add this line to your application's Gemfile:
|
||
|
|
|
||
|
|
[source,ruby]
|
||
|
|
----
|
||
|
|
gem 'knot'
|
||
|
|
----
|
||
|
|
|
||
|
|
And then execute:
|
||
|
|
|
||
|
|
[source,sh]
|
||
|
|
-----
|
||
|
|
$ bundle install
|
||
|
|
-----
|
||
|
|
|
||
|
|
Or install it yourself as:
|
||
|
|
|
||
|
|
[source,sh]
|
||
|
|
-----
|
||
|
|
$ gem install knot-ruby
|
||
|
|
-----
|
||
|
|
|
||
|
|
Usage
|
||
|
|
-----
|
||
|
|
|
||
|
|
TODO: Write usage instructions here
|
||
|
|
|
||
|
|
Development
|
||
|
|
-----------
|
||
|
|
|
||
|
|
To install this gem onto your local machine, run `bundle exec rake install`.
|
||
|
|
To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
||
|
|
|
||
|
|
Contributing
|
||
|
|
------------
|
||
|
|
|
||
|
|
Bug reports and pull requests are welcome at https://git.denkn.at/deac/knot-ruby.
|