README.md in load_file-1.0.0 vs README.md in load_file-1.1.0
- old
+ new
@@ -1,7 +1,16 @@
# LoadFile
+[][gem]
+[][travis]
+[][docinfo]
+
+[gem]: https://rubygems.org/gems/load_file
+[travis]: https://travis-ci.org/JuanitoFatas/load_file
+[docs]: https://inch-ci.org/github/juanitofatas/load_file
+[docinfo]: https://www.rubydoc.info/github/JuanitoFatas/load_file/master
+
Load/Overload YAML/JSON file(s) into desired constant.
## Installation
Add this line to your application's Gemfile:
@@ -26,16 +35,28 @@
=> {"name"=>"Small Sharp Tool",
...
"environments"=>{"test"=>{"scripts"=>{"test"=>"bundle exec rake test"}}}}
```
+You can also load into a namespaced constant:
+
+```ruby
+LoadFile.load(file: "examples/app.json", constant: :App, namespace: Heroku)
+
+# Heroku::App will be the hash loaded from examples/app.json
+```
+
+The caveat here is the keyword argument `namespace` must be a ruby object.
+
+Or should I introduce `constantize`? Please let me know.
+
### What if I want to override existing constant?
Use `overload` APIs.
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/JuanitoFatas/devyml.
+Bug reports and pull requests are welcome on GitHub at https://github.com/JuanitoFatas/loadfile.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).