README.md in truemail-rspec-0.1.1 vs README.md in truemail-rspec-0.1.2
- old
+ new
@@ -5,10 +5,11 @@
`truemail-rspec` gem helps you create `Truemail::Configuration` and `Truemail::Validator` instances for your RSpec environment.
## Table of Contents
- [Features](#features)
+- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Create configuration instance](#create-configuration-instance)
- [Configuration instance with default random params](#configuration-instance-with-default-random-params)
- [Configuration instance with predefined params](#configuration-instance-with-predefined-params)
@@ -17,13 +18,18 @@
- [create_validator DSL](#create_validator-dsl)
- [Truemail family](#truemail-family)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
+- [Credits](#credits)
- [Versioning](#versioning)
- [Changelog](CHANGELOG.md)
+## Requirements
+
+Ruby MRI 2.5.0+
+
## Features
- Ability to create `Truemail::Configuration` instance with random or with predefined params
- Ability to create `Truemail::Validator` instance with random or with predefined params
@@ -107,14 +113,18 @@
## Truemail family
All Truemail extensions: https://github.com/truemail-rb
-### truemail
+| Name | Type | Description |
+| --- | --- | --- |
+| [truemail](https://github.com/rubygarage/truemail) | ruby gem | Configurable plain Ruby email validator, main core |
+| [truemail server](https://github.com/truemail-rb/truemail-rack) | ruby app | Lightweight rack based web API wrapper for Truemail |
+| [truemail-rack-docker](https://github.com/truemail-rb/truemail-rack-docker-image) | docker image | Lightweight rack based web API [dockerized image](https://hub.docker.com/r/truemail/truemail-rack) :whale: of Truemail server |
+| [truemail-ruby-client](https://github.com/truemail-rb/truemail-ruby-client) | ruby gem | Truemail web API client library for Ruby |
+| [truemail-crystal-client](https://github.com/truemail-rb/truemail-crystal-client) | crystal shard | Truemail web API client library for Crystal |
-gem `truemail` - Configurable plain Ruby email validator, https://github.com/rubygarage/truemail
-
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/truemail-rb/truemail-rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Please check the [open tikets](https://github.com/truemail-rb/truemail-rspec/issues). Be shure to follow Contributor Code of Conduct below and our [Contributing Guidelines](CONTRIBUTING.md).
## License
@@ -122,9 +132,14 @@
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the `truemail-rspec` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Credits
+
+- [The Contributors](https://github.com/truemail-rb/truemail-rspec/graphs/contributors) for code and awesome suggestions
+- [The Stargazers](https://github.com/truemail-rb/truemail-rspec/stargazers) for showing their support
## Versioning
`truemail-rspec` uses [Semantic Versioning 2.0.0](https://semver.org)