README.md in ruby-ray-0.1.0 vs README.md in ruby-ray-0.2.0
- old
+ new
@@ -1,43 +1,39 @@
-# Ray
+# Debug with Ray to fix problems faster
-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/ray`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem can be installed in any Ruby application to send messages to [the Ray app](https://myray.app).
-TODO: Delete this and the text above, and describe your gem
+## Documentation
-## Installation
+You can find the full documentation on [our documentation site](https://spatie.be/docs/ray).
-Add this line to your application's Gemfile:
+## Changelog
-```ruby
-gem 'ray'
-```
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
-And then execute:
+## Contributing
- $ bundle install
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
-Or install it yourself as:
+## Contributing
- $ gem install ray
+Bug reports and pull requests are welcome on GitHub at https://github.com/spatie/ray. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/spatie/ray/blob/master/CODE_OF_CONDUCT.md).
-## Usage
+## Contributing
-TODO: Write usage instructions here
+Please see [CODE_OF_CONDUCT](.github/CODE_OF_CONDUCT.md) for details.
-## Development
+## Security Vulnerabilities
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Credits
-## Contributing
+- [Chris Oliver](https://github.com/excid3)
+- [Freek Van der Herten](https://github.com/freekmurze)
+- [All Contributors](../../contributors)
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ray. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ray/blob/master/CODE_OF_CONDUCT.md).
+A big thank you to Chris Oliver for teaching us the basics of Ruby development. You can see the initial development of this package [in this video](https://freek.dev/1904-creating-a-ruby-gem-for-ray).
## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Ray project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ray/blob/master/CODE_OF_CONDUCT.md).
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.