README.md in glob-0.2.0 vs README.md in glob-0.2.1
- old
+ new
@@ -1,36 +1,38 @@
-# Glob
+# glob
-[](https://github.com/fnando/glob/actions?query=workflow%3Atests)
+[](https://github.com/fnando/glob)
+[](https://codeclimate.com/github/fnando/glob)
+[](https://rubygems.org/gems/glob)
+[](https://rubygems.org/gems/glob)
-Create a list of hash paths that match a given pattern. You can also generate
-a hash with only the matching paths.
+Create a list of hash paths that match a given pattern. You can also generate a
+hash with only the matching paths.
## Installation
-Add this line to your application's Gemfile:
+```bash
+gem install glob
+```
+Or add the following line to your project's Gemfile:
+
```ruby
gem "glob"
```
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
- $ gem install glob
-
## Usage
There are two types of paths: `include` and `exclude`.
- The `include` path adds that node to the new hash.
-- The `exclude` path is the one started by `!`, and will prevent that path from being added.
+- The `exclude` path is the one started by `!`, and will prevent that path from
+ being added.
-The latest rules have more precedence; that means that if you have the rule `*.messages.*`, then add a following rule as `!*.messages.bye`, all `*.messages.*` but `*.messages.bye` will be included.
+The latest rules have more precedence; that means that if you have the rule
+`*.messages.*`, then add a following rule as `!*.messages.bye`, all
+`*.messages.*` but `*.messages.bye` will be included.
```ruby
glob = Glob.new(
site: {
settings: {
@@ -65,22 +67,29 @@
#=> }
```
Notice that the return result will have symbolized keys.
-## Development
+## Maintainer
-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.
+- [Nando Vieira](https://github.com/fnando)
-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).
+## Contributors
+- https://github.com/fnando/glob/contributors
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/glob. 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.
+For more details about how to contribute, please read
+https://github.com/fnando/glob/blob/main/CONTRIBUTING.md.
## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/glob/blob/main/LICENSE.md.
## Code of Conduct
-Everyone interacting in the Glob project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/glob/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the glob project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/glob/blob/main/CODE_OF_CONDUCT.md).