Skip to content

Commit

Permalink
add brief notes on usage
Browse files Browse the repository at this point in the history
  • Loading branch information
markburns committed Dec 24, 2023
1 parent e8d79ec commit 6cfb6b0
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# DeepMatching

TODO: Delete this and the text below, and describe your gem

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.
This allows you to get detailed error messages on exactly where your heavily nested hashes differ

## Installation

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

## Usage

TODO: Write usage instructions here
```ruby
require 'deep_matching'
RSpec.configure do |config|
config.include DeepMatching
end
```

## Development

Expand Down

0 comments on commit 6cfb6b0

Please sign in to comment.