Skip to content

Commit a4b03fa

Browse files
author
Lee Richmond
committed
Update README.md
1 parent c96555f commit a4b03fa

File tree

1 file changed

+2
-38
lines changed

1 file changed

+2
-38
lines changed

README.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,5 @@
11
# JsonapiErrorable
22

3-
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/jsonapi_errorable`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
6-
7-
## Installation
8-
9-
Add this line to your application's Gemfile:
10-
11-
```ruby
12-
gem 'jsonapi_errorable'
13-
```
14-
15-
And then execute:
16-
17-
$ bundle
18-
19-
Or install it yourself as:
20-
21-
$ gem install jsonapi_errorable
22-
23-
## Usage
24-
25-
TODO: Write usage instructions here
26-
27-
## Development
28-
29-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30-
31-
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).
32-
33-
## Contributing
34-
35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsonapi_errorable.
36-
37-
38-
## License
39-
40-
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
3+
Error handling patterns for jsonapi.org-compatible APIs.
414

5+
[View official documentation](https://bbgithub.dev.bloomberg.com/pages/InfrastructureExperience/jsonapi_errorable)

0 commit comments

Comments
 (0)