README.md in sinclair-1.14.0 vs README.md in sinclair-1.14.1
- old
+ new
@@ -7,21 +7,23 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9836de08612e46b889c7978be2b72a14)](https://www.codacy.com/manual/darthjee/sinclair?utm_source=github.com&utm_medium=referral&utm_content=darthjee/sinclair&utm_campaign=Badge_Grade)
[![Inline docs](http://inch-ci.org/github/darthjee/sinclair.svg?branch=master)](http://inch-ci.org/github/darthjee/sinclair)
![sinclair](https://raw.githubusercontent.com/darthjee/sinclair/master/sinclair.jpg)
-This gem helps the creation of complex gems/concerns
-that enables creation of methods on the fly through class
-methods
+Sinclair is a Ruby gem that provides developers with a variety of utility modules and classes
+to simplify common tasks, reusability and avoid boilerplate code. Whether you need to class methods to create methods on the fly,
+create custom comparators, configure your application, create powerfull options, Sinclair has got you covered.
-Current Release: [1.14.0](https://github.com/darthjee/sinclair/tree/1.14.0)
+Employing Sinclair in your applications helps you streamline your development workflow and enhance your development process through more efficient, cleaner code
-[Next release](https://github.com/darthjee/sinclair/compare/1.14.0...master)
+Current Release: [1.14.1](https://github.com/darthjee/sinclair/tree/1.14.1)
+[Next release](https://github.com/darthjee/sinclair/compare/1.14.1...master)
+
Yard Documentation
-------------------
-[https://www.rubydoc.info/gems/sinclair/1.14.0](https://www.rubydoc.info/gems/sinclair/1.14.0)
+[https://www.rubydoc.info/gems/sinclair/1.14.1](https://www.rubydoc.info/gems/sinclair/1.14.1)
Installation
---------------
- Install it
@@ -522,13 +524,21 @@
```
</details>
### Sinclair::EnvSettable
-Settable allows classes to extract configuration from environments through
-a simple meta-programable way
+EnvSettable is a convenient utility that allows you to read environment
+variables using Ruby class methods.
+With this tool, you can define the usage of environment variables for your application in a single location
+allowing the use of prefixes to isolate groups of variables.
+
+This not only makes your code more readable and maintainable but also adds layer of security by ensuring
+that sensitive information like API keys and passwords are not exposed in your source code.
+
+EnvSettable allows accessing those variables thorugh a simple meta-programable way
+
<details>
<summary>Using env settable example</summary>
```ruby
class ServiceClient
@@ -643,10 +653,11 @@
<details>
<summary>Example with options</summary>
```ruby
-class Tv < Sinclair::Model.for(:model, writter: false, comparable: false)
+class Tv < Sinclair::Model
+ initialize_with :model, writter: false, comparable: false
end
tv1 = Tv.new(model: 'Sans Sunga Xt')
tv2 = Tv.new(model: 'Sans Sunga Xt')