README.md in bbc-cosmos-config-0.0.4 vs README.md in bbc-cosmos-config-0.0.5
- old
+ new
@@ -1,8 +1,8 @@
-# Bbc::Cosmos::Config
+# BBC::Cosmos::Config
-TODO: Write a gem description
+Abstracts logic (required by multiple other BBC specific gems) surrounding configuration data loading and access.
## Installation
Add this line to your application's Gemfile:
@@ -16,14 +16,22 @@
$ gem install bbc-cosmos-config
## Usage
-TODO: Write usage instructions here
+```
+require "bbc/cosmos/config"
+BBC::Cosmos.production? # => true/false depending on ENV["APP_ENV"]
+
+BBC::Cosmos::Config.aws # => returns object that provides methods for accessing AWS information
+BBC::Cosmos::Config.cosmos # => returns object that provides methods for accessing Cosmos information
+BBC::Cosmos::Config.app # => returns object that provides methods for specific json configuration key values
+```
+
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/bbc-cosmos-config/fork )
+1. Fork it ( http://github.com/BBC-News/bbc-cosmos-config/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request