README.md in shoulda-context-2.0.0 vs README.md in shoulda-context-3.0.0.rc1
- old
+ new
@@ -1,9 +1,9 @@
# Shoulda Context [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] ![Downloads][downloads-badge] [![Hound][hound-badge]][hound]
[version-badge]: https://img.shields.io/gem/v/shoulda-context.svg
-[rubygems]: https://rubygems.org/gems/shoulda-matchers
+[rubygems]: https://rubygems.org/gems/shoulda-context
[travis-badge]: https://img.shields.io/travis/thoughtbot/shoulda-context/master.svg
[travis]: https://travis-ci.org/thoughtbot/shoulda-context
[downloads-badge]: https://img.shields.io/gem/dtv/shoulda-context.svg
[hound-badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
[hound]: https://houndci.com
@@ -12,18 +12,39 @@
under Minitest and Test::Unit within Rails projects or plain Ruby projects. It's
fully compatible with your existing tests and requires no retooling to use.
## Quick links
-📖 **[Read the documentation for the latest version.][rubydocs]**
+📖 **[Read the documentation for the latest version.][rubydocs]**
📢 **[See what's changed in recent versions.][changelog]**
[rubydocs]: http://rubydoc.info/github/thoughtbot/shoulda-context/master/frames
[changelog]: CHANGELOG.md
-## Usage
+[shoulda-context]: https://github.com/thoughtbot/shoulda-context
+## Getting started
+
+If you're working on a Rails app, then make sure to add this gem to the `test`
+group in your Gemfile:
+
+``` ruby
+group :test do
+ gem 'shoulda-context', '~> 3.0.0.rc1'
+end
+```
+
+If you're not working on a Rails app, then you can simply add:
+
+``` ruby
+gem 'shoulda-context', '~> 3.0.0.rc1'
+```
+
+Then run `bundle install`.
+
+## Overview
+
Instead of writing Ruby methods with `lots_of_underscores`, Shoulda Context lets
you name your tests and group them together using English.
At a minimum, the gem provides some convenience layers around core Minitest /
Test::Unit functionality. For instance, this test case:
@@ -136,43 +157,56 @@
* `assert_accepts` — what `should` uses internally; asserts that a matcher
object matches against a value
* `assert_reject` — what `should_not` uses internally; asserts that a matcher
object does not match against a value
-## Note on running tests
+## Compatibility
-Normally, you will run a single test like this:
+Shoulda Context is [tested][travis] and supported against Ruby 2.7+, Rails 6.0+,
+Minitest 4.x, and Test::Unit 3.x.
- ruby -I lib -I test path_to_test.rb -n name_of_test_method
+## Versioning
-When using Shoulda Context, however, you'll need to put a space after the test
-name:
+Shoulda Context follows Semantic Versioning 2.0 as defined at
+<http://semver.org>.
- ruby -I lib -I test path_to_test.rb -n "test_: a calculator should add two numbers for the sum. "
+## Team
-If this is too cumbersome, consider using the [m] gem to run tests instead:
+Shoulda Context is currently maintained by [Pedro Paiva][VSPPedro]. Previous
+maintainers include [Elliot Winkler][mcmire], [Travis Jeffery][travisjeffery],
+[Gabe Berke-Williams][gabebw], [Ryan McGeary][rmm5t], [Joe Ferris][jferris], [Dan
+Croaky][croaky], and [Tammer Saleh][tammersaleh].
- m path_to_test.rb:39
+[VSPPedro]: https://github.com/VSPPedro
+[mcmire]: https://github.com/mcmire
+[travisjeffery]: https://github.com/travisjeffery
+[gabebw]: https://github.com/gabebw
+[rmm5t]: https://github.com/rmm5t
+[jferris]: https://github.com/jferris
+[croaky]: https://github.com/croaky
+[tammersaleh]: https://github.com/tammersaleh
-[m]: https://github.com/qrush/m
+## Copyright/License
-## Compatibility
+Shoulda Context is copyright © Tammer Saleh and [thoughtbot,
+inc][thoughtbot-website]. It is free and opensource software and may be
+redistributed under the terms specified in the [LICENSE](LICENSE) file.
-Shoulda Context is tested and supported against Rails 4.x+, Minitest 4.x,
-Test::Unit 3.x, and Ruby 2.4+.
+[thoughtbot-website]: https://thoughtbot.com?utm_source=github
-## Credits
+<!-- START /templates/footer.md -->
+## About thoughtbot
-Shoulda Context is maintained by [Elliot Winkler][elliot-winkler], [Travis
-Jeffery][travis-jeffery], and thoughtbot. Thank you to all the [contributors].
+
-[elliot-winkler]: https://github.com/mcmire
-[travis-jeffery]: https://github.com/travisjeffery
-[contributors]: https://github.com/thoughtbot/shoulda-context/contributors
+This repo is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
-## License
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
-Shoulda Context is copyright © 2006-2020 [thoughtbot, inc][thoughtbot-website].
-It is free software, and may be redistributed under the terms specified in the
-[MIT-LICENSE](MIT-LICENSE) file.
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
-[thoughtbot-website]: https://thoughtbot.com
+
+<!-- END /templates/footer.md -->