README.md in harmony-service-0.2.0 vs README.md in harmony-service-0.3.0

- old
+ new

@@ -1,41 +1,21 @@ # Harmony::Service -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/harmony/service`. To experiment with that code, run `bin/console` for an interactive prompt. +The Harmony Service gem simplifies creation of a Service in the Harmony Platform. -TODO: Delete this and the text above, and describe your gem - ## Installation -Add this line to your application's Gemfile: +1. Create a new Service via the Harmony platform +1. Download the code for your Service. +1. Run `bundle install` -```ruby -gem 'harmony-service' -``` - -And then execute: - - $ bundle - -Or install it yourself as: - - $ gem install harmony-service - ## Usage -TODO: Write usage instructions here +In order to test your code locally you can run `bundle exec rspec`. Once you have completed development you can upload into the Harmony Platform. ## 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. +Your Service should respond to request messages appropriately. You can find the relevant mappings [here](https://github.com/HarmonyMobile/harmony-service/blob/master/lib/harmony/service/rpc_service.rb#L95). -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]/harmony-service. - - ## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). - +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). \ No newline at end of file