Skip to content

Commit

Permalink
👍 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
unhappychoice committed Sep 14, 2019
1 parent e62aa86 commit b942733
Showing 1 changed file with 10 additions and 18 deletions.
28 changes: 10 additions & 18 deletions README.md
@@ -1,8 +1,13 @@
# Irasutoya

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/irasutoya`. To experiment with that code, run `bin/console` for an interactive prompt.
[![Gem Version](https://badge.fury.io/rb/irasutoya.svg)](https://badge.fury.io/rb/irasutoya)
[![Code Climate](https://codeclimate.com/github/unhappychoice/irasutoya/badges/gpa.svg)](https://codeclimate.com/github/unhappychoice/irasutoya)
[![codecov](https://codecov.io/gh/unhappychoice/irasutoya/branch/master/graph/badge.svg)](https://codecov.io/gh/unhappychoice/irasutoya)
[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/unhappychoice/irasutoya.svg)](https://libraries.io/github/unhappychoice/irasutoya)
![](http://ruby-gem-downloads-badge.herokuapp.com/irasutoya?type=total)
![GitHub](https://img.shields.io/github/license/unhappychoice/irasutoya.svg)

TODO: Delete this and the text above, and describe your gem
`Irasutoya` is ruby library and CLI tool for [いらすとや](https://www.irasutoya.com)

## Installation

Expand All @@ -11,24 +16,11 @@ Add this line to your application's Gemfile:
```ruby
gem 'irasutoya'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install irasutoya

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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).
```ruby
Irasutoya.random #=> Returns a random image from irasutoya
```

## Contributing

Expand Down

0 comments on commit b942733

Please sign in to comment.