README.md in key_tree-0.3.2 vs README.md in key_tree-0.4.0
- old
+ new
@@ -1,13 +1,12 @@
-[](https://badge.fury.io/rb/key_tree)
+[](https://badge.fury.io/rb/key_tree) [](https://codeclimate.com/github/notCalle/ruby-keytree/maintainability)
# KeyTree
-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/key_tree`. To experiment with that code, run `bin/console` for an interactive prompt.
+KeyTree manages trees of hashes, and (possibly nested) forests of such trees,
+allowing access to values by key path.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -22,24 +21,33 @@
$ gem install key_tree
## Usage
-TODO: Write usage instructions here
+```ruby
+kt=KeyTree::Tree[a: { b: 1 }]
+kt['a.b']
+=> 1
+kf=KeyTree::Forest[kt, {b: { c: 2 }}]
+kt['a.b']
+=> 1
+kf['b.c']
+=> 2
+```
## 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/key_tree. 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/notCalle/key_tree. 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.
## 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 KeyTree project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/key_tree/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the KeyTree project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/notCalle/key_tree/blob/master/CODE_OF_CONDUCT.md).