README.md in sequel-batches-0.2.1 vs README.md in sequel-batches-1.0.0
- old
+ new
@@ -1,8 +1,8 @@
-# Sequel::Batches [](https://travis-ci.org/umbrellio/sequel-batches) [](https://coveralls.io/github/umbrellio/sequel-batches?branch=master)
+# Sequel::Batches [](https://badge.fury.io/rb/sequel-batches) [](https://travis-ci.org/umbrellio/sequel-batches) [](https://coveralls.io/github/umbrellio/sequel-batches?branch=master)
-This dataset extension provides the method #in_batches. The method splits dataset in parts and yields it.
+This dataset extension provides the `#in_batches` method. The method splits dataset in parts and yields it.
Note: currently only PostgreSQL database is supported.
You can set the following options:
@@ -36,44 +36,45 @@
$ gem install sequel-batches
## Usage
-In order to use the feature you should enable the extension
+In order to use the feature you should enable the extension:
```ruby
Sequel::DATABASES.first.extension :batches
```
-And then the method becomes available on dataset
+After that the `#in_batches` method becomes available on dataset:
```ruby
User.where(role: "admin").in_batches(of: 4) do |ds|
ds.delete
end
```
-Finally, here's an example including all the available options
+Finally, here's an example including all the available options:
```ruby
-Event.where(type: "login").in_batches(of: 4, pk: [:project_id, :external_user_id], start: { project_id: 2, external_user_id: 3 }, finish: { project_id: 5, external_user_id: 70 }) do |ds|
+options = {
+ of: 4,
+ pk: [:project_id, :external_user_id],
+ start: { project_id: 2, external_user_id: 3 },
+ finish: { project_id: 5, external_user_id: 70 },
+}
+
+Event.where(type: "login").in_batches(options) do |ds|
ds.delete
end
```
-## Development
-
-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]/sequel-batches. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/umbrellio/sequel-batches.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-## Code of Conduct
-
-Everyone interacting in the Sequel::Batches project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sequel-batches/blob/master/CODE_OF_CONDUCT.md).
+<a href="https://github.com/umbrellio/">
+<img style="float: left;" src="https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg" alt="Supported by Umbrellio" width="439" height="72">
+</a>