OSDN Git Service

Fix description message.
[osdn-codes/osdn-cli.git] / README.md
1 # Osdn::Cli
2
3 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/osdn/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
4
5 TODO: Delete this and the text above, and describe your gem
6
7 ## Installation
8
9 Add this line to your application's Gemfile:
10
11 ```ruby
12 gem 'osdn-cli'
13 ```
14
15 And then execute:
16
17     $ bundle
18
19 Or install it yourself as:
20
21     $ gem install osdn-cli
22
23 ## Usage
24
25 TODO: Write usage instructions here
26
27 ## Development
28
29 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.
30
31 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).
32
33 ## Contributing
34
35 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/osdn-cli.
36