README.md in smart_initializer-0.3.2 vs README.md in smart_initializer-0.4.0
- old
+ new
@@ -1,6 +1,6 @@
-# SmartCore::Initializer · [![Gem Version](https://badge.fury.io/rb/smart_initializer.svg)](https://badge.fury.io/rb/smart_initializer) [![Build Status](https://travis-ci.org/smart-rb/smart_initializer.svg?branch=master)](https://travis-ci.org/smart-rb/smart_initializer)
+# SmartCore::Initializer · [![Gem Version](https://badge.fury.io/rb/smart_initializer.svg)](https://badge.fury.io/rb/smart_initializer)
A simple and convenient way to declare complex constructors with a support for various commonly used type systems.
(**in active development**).
## Installation
@@ -28,11 +28,12 @@
- [Configuration](#configuration)
- [Type aliasing](#type-aliasing)
- [Initialization extension](#initialization-extension)
- [Plugins](#plugins)
- [thy-types](#plugin-thy-types)
-- [How to run tests](#how-to-run-tests)
+- [Roadmap](#roadmap)
+- [Build](#build)
---
## Synopsis
@@ -284,12 +285,23 @@
# => SmartCore::Initializer::ThyTypeValidationError
```
---
-## How to run tests
+## Roadmap
+- Attribue Definition DSL
+ - Support for specifying the attribute accessor type (`read_only` parameter);
+ - Support for attribute aliasing (`as` parameter);
+- Migrate from `TravisCI` to `GitHub Actions`;
+
+---
+
+## Build
+
+### Tests Running
+
- with plugin tests:
```shell
bin/rspec -w
```
@@ -302,9 +314,23 @@
- help message:
```shell
bin/rspec -h
+```
+
+### Code Style Checking
+
+- without auto-correction:
+
+```shell
+bundle exec rake rubocop
+```
+
+- with auto-correction:
+
+```shell
+bundle exec rake rubocop -A
```
---
## Contributing