README.md in mongoid-bulk-import-0.1.0 vs README.md in mongoid-bulk-import-0.2.0
- old
+ new
@@ -1,11 +1,9 @@
# Mongoid::Bulk::Import
-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/mongoid/bulk/import`. To experiment with that code, run `bin/console` for an interactive prompt.
+ This gem adds an `bulk_insert` method to mongoid classes for bulk inserting data with validations support.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,16 +18,32 @@
$ gem install mongoid-bulk-import
## Usage
-TODO: Write usage instructions here
+### Sample a single document
-## Development
+```ruby
-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.
+class MyModel
+ include Mongoid::Document
+ field :name
+end
-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).
+MyModel.bulk_insert({ name: "Jack" })
+```
+
+### Sample multiple documents
+
+```ruby
+
+class MyModel
+ include Mongoid::Document
+ field :name
+end
+
+MyModel.bulk_insert([{ name: "Jack" }, { name: "Matt" }])
+```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mongoid-bulk-import. 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.