README.md in remetric-0.0.13 vs README.md in remetric-1.0.0

- old
+ new

@@ -1,16 +1,18 @@ # Remetric -Remetric tracks your user data in a snap! +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/remetric`. To experiment with that code, run `bin/console` for an interactive prompt. -This gem interacts with our API. +TODO: Delete this and the text above, and describe your gem ## Installation Add this line to your application's Gemfile: - gem 'remetric' +```ruby +gem 'remetric' +``` And then execute: $ bundle @@ -18,32 +20,17 @@ $ gem install remetric ## Usage -`Key` is always required! +TODO: Write usage instructions here -``` -r = Remetric.new "#{remetric_api_token}" +## Development -r.track "{{ name }} signed in with {{ email }}.", { - key: user.id, - email: user.email, - name: user.name, - last_sign_in: Time.now.to_i, - comments: user.comments.count -} +After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. -r.save_contact({ - key: user.id, - email: user.email, - name: user.name -}) -``` +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 -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/remetric. +