README.md in lita_dotenv-0.0.2 vs README.md in lita_dotenv-0.0.3

- old
+ new

@@ -7,12 +7,18 @@ [![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link] [![Downloads][downloads-svg]][downloads-link] [![Docs][docs-rubydoc-svg]][docs-rubydoc-link] [![License][license-svg]][license-link] -`lita_dotenv` is designed to allow storing an entire [Lita bot](https://www.lita.io/) config in an `.env` file. The `lita_config.rb` file should be as simple as: +`lita_dotenv` is designed to allow storing an entire [Lita bot](https://www.lita.io/) config in an `.env` file including the following: +* map environment variables to Lita config properties +* coerce environment variable value types to Ruby types +* load .env file if exists + + The `lita_config.rb` file should be as simple as: + ```ruby require 'lita_dotenv' Lita.configure do |config| config = LitaDotenv.new(config).config @@ -58,9 +64,13 @@ Lita.configure do |config| config = LitaDotenv.new(config).config end ``` + +## To Do + +* Map config hash key values, e.g. `config.redis[:url]` ## Change Log See [CHANGELOG.md](CHANGELOG.md)