Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grokify committed Sep 2, 2016
1 parent a3f22c0 commit 7a97fd4
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Expand Up @@ -9,7 +9,13 @@ Lita Dotenv Config Loader
[![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'
Expand Down Expand Up @@ -61,6 +67,10 @@ Lita.configure do |config|
end
```

## To Do

* Map config hash key values, e.g. `config.redis[:url]`

## Change Log

See [CHANGELOG.md](CHANGELOG.md)
Expand Down

0 comments on commit 7a97fd4

Please sign in to comment.