settei 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d7db95b9bd55c016fd36a30e28f42d6c360fadf
-  data.tar.gz: 6a6638dc0f1403b4070bdfde0ec9194f52683f44
+  metadata.gz: 420fd42e68113f4e584bd112c0fcf0614d5f9622
+  data.tar.gz: e3fb141eca64df590927a41d97ce581832ec697f
 SHA512:
-  metadata.gz: 6a052e47b595948163a00b02a1138b09124acbff2d3fce28cf5882d5f6e2761899ff8c9cd065623e26186a0abb72e0e12073e06af66698dcf6cc473ec9f927e6
-  data.tar.gz: '094233cf0983684d86bf189e1b4a18119335356a992e5a4d7859d93da4bf1bed70bf6f9608257809fc8a00f812323df06e9dd131d98bc2289271eabc1e4dab41'
+  metadata.gz: '083334231d67b72fbfb8fada4b0212e58d709bf4b94ff8c679e09342d9a96fbc83fc38378edebcc7a61d928f6c632ac22df0b7e0d571c7f25c2846810629dc1b'
+  data.tar.gz: '058da9d1f4ef97479c449d9a6edcec8ac6a31c9e52f129da5601290a6b9e7861d0b2f0b59ab05c636c4fe12089ca9f9123d621fc2c2a5e61033c7431574e1c14'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    settei (0.1.0)
+    settei (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -29,7 +29,7 @@ Or install it yourself as:
 
 For Rails, a rake task is available for simple setup:
 
-    $ settei:install:rails
+    $ rake settei:install:rails
 
 A `config/setting.rb` file is added for basic setup.
  
@@ -41,7 +41,7 @@ In your app, you can access the settings like this:
 Setting.dig(:google, :api, :secret)
 ```
 
-## Settei::Base
+### Settei::Base 
 
 `Settei::Base` is the core class for accessing the configurations. It is initialized by a hash. It is a light wrapper intended for you to extend.
 
@@ -49,9 +49,11 @@ Setting.dig(:google, :api, :secret)
 
 `#dig_and_wrap` will return a `Settei::Base` if it the return value is a hash.
 
+For other methods, [check here](http://www.rubydoc.info/github/lulalala/settei/master/Settei/Base).
+
 Install script maps `Setting` to an instance of `Settei::Base`, for convenience.
 
-## Loader
+### Loader
 
 `Settei::Loaders::SimpleLoader` is responsible for providing the hash to initialize `Settei::Base`. It loads from a source such as YAML or environment variable. It can also serialize the whole hash into one string, suitable for deploying via environment variables.
 
@@ -62,13 +64,15 @@ loader.load(:production).as_env_value # loads production.yml and returns "XYZ"
 loader.load(:test).as_env_assignment # loads test.yml and returns "APP_CONG=XYZ"
 ```
 
-We welcome PRs for different types of loaders, as `SimpleLoader` is not suitable for every situation.
+We welcome PRs for different types of loaders, as `SimpleLoader` probably can't handle all situations.
+
+For other methods, [check here](http://www.rubydoc.info/github/lulalala/settei/master/Settei/Loaders/SimpleLoader).
 
-## Deployment
+### Deployment
 
 If `deploy.rb` is present, `rake settei:install:rails` will append code to it, allow serialized config to be passed as an environment variable.
 
-## Frameworks other than Rails
+### Frameworks other than Rails
 
 Settei is designed to be simple so you can integrate it into any frameworks easily. The steps are mainly:
 
@@ -79,11 +83,11 @@ Settei is designed to be simple so you can integrate it into any frameworks easi
 
 We also welcome PRs for generators of other frameworks too.
 
-# Ruby < 2.3
+## Ruby < 2.3
 
 `Settei::Base` uses `dig` to access the configuration, available since Ruby 2.3. If your Ruby is not new enough, don't be afraid. Write your own hash accessor literally takes minutes. You can even use `SettingsLogic.new(hash)` .
 
-# FAQ
+## FAQ
 
 **Q:** Would serialized configuration be too big for environment variable?  
 **A:** [The upper limit is pretty big.](https://stackoverflow.com/a/1078125/474597)

data/lib/settei/version.rb

@@ -1,3 +1,3 @@
 module Settei
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/settei.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["lulalala"]
   spec.email         = ["mark@goodlife.tw"]
 
-  spec.summary       = %q{Ruby configuration}
-  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.summary       = %q{Hash based configuration}
+  spec.description   = %q{Hash based configuration with flexibility and 12-factor app deployment in mind. Settei allows use of nested hash, and can be serialized as environment variable, suitable for 12-factor app.}
   spec.homepage      = "https://github.com/lulalala/settei"
   spec.licenses      = ['MIT']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: settei
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - lulalala
@@ -66,7 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Hash based configuration with flexibility and 12-factor app deployment
+  in mind. Settei allows use of nested hash, and can be serialized as environment
+  variable, suitable for 12-factor app.
 email:
 - mark@goodlife.tw
 executables: []
@@ -118,5 +120,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Ruby configuration
+summary: Hash based configuration
 test_files: []