Skip to content

Commit 6cfb6b0

Browse files
committed
add brief notes on usage
1 parent e8d79ec commit 6cfb6b0

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# DeepMatching
22

3-
TODO: Delete this and the text below, and describe your gem
4-
5-
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/deep_matching`. To experiment with that code, run `bin/console` for an interactive prompt.
3+
This allows you to get detailed error messages on exactly where your heavily nested hashes differ
64

75
## Installation
86

@@ -18,7 +16,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
1816

1917
## Usage
2018

21-
TODO: Write usage instructions here
19+
```ruby
20+
require 'deep_matching'
21+
RSpec.configure do |config|
22+
config.include DeepMatching
23+
end
24+
```
2225

2326
## Development
2427

0 commit comments

Comments
 (0)