README.md in redmine_rest-0.1.0 vs README.md in redmine_rest-0.1.1

- old
+ new

@@ -1,10 +1,9 @@ # RedmineRest -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/redmine_rest`. To experiment with that code, run `bin/console` for an interactive prompt. +This is gem with some ActiveResource models for Redmine. -TODO: Delete this and the text above, and describe your gem ## Installation Add this line to your application's Gemfile: @@ -20,22 +19,19 @@ $ gem install redmine_rest ## Usage -TODO: Write usage instructions here + RedmineRest::Models.configure_models user: 'user', password: 'password', site: 'URL' + # or by using apikey: + RedmineRest::Models.configure_models apikey: 'apikey', site: 'URL' + issue = RedmineRest::Models::Issue.find(1234) -## 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). - ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redmine_rest. +Bug reports and pull requests are welcome on GitHub at https://github.com/Nondv/redmine_rest. ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). -