clean up adapter READMEs.

This commit is contained in:
Micah Geisel 2019-05-20 16:03:59 -06:00
parent 29e61aba36
commit b4850f6616
11 changed files with 139 additions and 301 deletions

View file

@ -1,28 +1,22 @@
# DatabaseCleaner::Ohm
# Database Cleaner Adapter for Ohm
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/database_cleaner/ohm`. To experiment with that code, run `bin/console` for an interactive prompt.
[![Build Status](https://travis-ci.org/DatabaseCleaner/database_cleaner-ohm.svg?branch=master)](https://travis-ci.org/DatabaseCleaner/database_cleaner-ohm)
[![Code Climate](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-ohm/badges/gpa.svg)](https://codeclimate.com/github/DatabaseCleaner/database_cleaner-ohm)
TODO: Delete this and the text above, and describe your gem
Clean your Ohm databases with Database Cleaner.
See https://github.com/DatabaseCleaner/database_cleaner for more information.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'database_cleaner-ohm'
# Gemfile
group :test do
gem 'database_cleaner-ohm'
end
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install database_cleaner-ohm
## Usage
### Configuration options
## Configuration options
`:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)).
@ -41,16 +35,6 @@ Or install it yourself as:
</tbody>
</table>
## Development
## COPYRIGHT
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.
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).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/database_cleaner-ohm.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
See [LICENSE] for details.