Skip to content
Snippets Groups Projects
README.md 948 B
Newer Older
Jason Little's avatar
Jason Little committed
# KmRuby

Wraps the kmdata service and provides a CLI interface to it.

The API for this should presently be considered unstable. It is probable that it will be refactored
to wrap the JSON returns a little better and provide more entity specific accessors.

## Versioning

Minor version number changes can break the api

```
1.0, 1.1, 1.2, 1.3, etc.
```

but not point releases:

```
1.0.1, 1.0.2, 1.0.3, etc.
```

The major version number will always match up with the major kmdata version.

## Requirements

Ruby 2.0 or greater

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'kmruby', git: 'https://code.osu.edu/kmdata/kmruby.git'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ git clone https://code.osu.edu/kmdata/kmruby.git
    $ cd kmruby
    $ rake install

## CLI Usage

See all commands:

    $ kmruby


or


    $ kmruby help [command]


to see help documentation for that command.