Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.24 KB

README.md

File metadata and controls

60 lines (38 loc) · 1.24 KB

Catz

Installation

Add this line to your application's Gemfile:

gem 'catz'

And then execute:

$ bundle

Or install it yourself as:

$ gem install catz

Usage

#####Catz allows you to call the following commands:

Opens a cat image in your browser:

catz browser

saves a cat image to your desktop:

catz file

prints out a fun cat fact:

catz fact

Prints out the number of categories you can browse:

catz categories

** Please note that this is compatible with OSX systems only

TODO

Tests need fixing up

Development

After checking out the repo, run bundle install to install dependencies. Then, run rake to run the tests.

To install this gem onto your local machine, run gem build catz.gemspec, then gem install ./catz-0.0.0.gem with the relevant version number

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cwrw/cats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.