README.md in distributed_merge-0.1.0 vs README.md in distributed_merge-0.1.1
- old
+ new
@@ -1,41 +1,42 @@
# DistributedMerge
-[] [](https://github.com/grosser/single_cov)
+[](https://github.com/grosser/single_cov)
'distributed_merge' is a Ruby gem that adds a method to Array class that allows
merge interleaving arrays of non-equal length with elements being equally
distributed. The method can be called on a two-dimensional array containing two
or more sub-arrays of various size.
-
-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/distributed_merge`. To experiment with that code, run `bin/console` for an interactive prompt.
-
## Installation
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+To install the gem run the following command in the terminal:
-Install the gem and add to the application's Gemfile by executing:
+ $ bundle add distributed_merge
- $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
If bundler is not being used to manage dependencies, install the gem by executing:
- $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+ $ gem install distributed_merge
## Usage
-TODO: Write usage instructions here
+To add the distributed_merge method to your project include it in your project like so:
+```ruby
+require 'distributed_merge'
+```
-## Development
+When included the method can be called on any two-dimensional array containing sub-arrays of various size (non-equal length) and it will return a single layer merged array with all the elements of the sub-arrays evenly interleaved and distributed.
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+[[1, 2, 3, 4], ['a', 'b'], ['C']].distributed_merge
+# => [1, "b", 2, "C", 3, "a", 4]
+```
-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 the created tag, 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/msuliq/distributed_merge. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/msuliq/distributed_merge/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome at https://github.com/msuliq/distributed_merge. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/msuliq/distributed_merge/blob/main/CODE_OF_CONDUCT.md).
+
+The best way to contribute would be to fork this repo, create a new branch from main, to merge the branch into main of the fork once the new code is in place and then open a pull request to merge forked main into the main of the present repo.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).