README.md in smart_injection-0.1.0 vs README.md in smart_injection-0.2.0
- old
+ new
@@ -1,8 +1,8 @@
-# SmartCore::Injection · [](https://badge.fury.io/rb/smart_injection) [](https://travis-ci.org/smart-rb/smart_injection)
+# SmartCore::Injection · [](https://badge.fury.io/rb/smart_injection)
-Dependency injection principles and idioms realized in scope of Ruby.
+Dependency injection principles and idioms realized in scope of Ruby. Support for method-injeciton strategy, container-based dependency resolving, static and dynamic bindings and etc.
---
## Major Features
@@ -20,10 +20,22 @@
- an ability to import from any manually passed IoC-container;
- privacy control of injected dependency (public/private/protected);
---
+## Usage
+
+- [Installation](#installation)
+- [Synopsis](#synopsis)
+- [Roadmap](#roadmap)
+- [Build](#build)
+- [Contributing](#contributing)
+- [License](#license)
+- [Authors](#authors)
+
+---
+
## Installation
```ruby
gem 'smart_injection'
```
@@ -99,9 +111,39 @@
self.class.cache # => returns data_storage.cache
self.class.hexer # => returns rands.hexer
phone_client # => returns phone_clients.nexmo
end
end
+```
+
+---
+
+## Roadmap
+
+- **[0.3.0]** - support for default injection configuration which should be specified in `SmartCore::Injection` module inclusion (in addition to default containers)
+- **[0.x.0]** - more docs, more examples, more tips-and-tricks :)
+- **[0.x.0]** - migrate to GithubActions;
+
+---
+
+## Build
+
+- run tests:
+
+```shell
+bundle exce rake rspec
+```
+
+- run code style checking:
+
+```shell
+bundle exec rake rubocop
+```
+
+- run code style checking with auto-correction:
+
+```shell
+bundle exec rake rubocop -A
```
---
## Contributing