Go to file
Denis Knauf b669500037 README.adoc + merge 2020-06-20 22:49:23 +02:00
lib init 2020-06-20 22:30:05 +02:00
.gitignore README.adoc + merge 2020-06-20 22:49:23 +02:00
Gemfile init 2020-06-20 22:30:05 +02:00
LICENSE Initial commit 2020-06-20 22:33:24 +02:00
README.adoc README.adoc + merge 2020-06-20 22:49:23 +02:00
Rakefile init 2020-06-20 22:30:05 +02:00
knot-ruby.gemspec init 2020-06-20 22:30:05 +02:00

README.adoc

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.