README.md in truemail-rspec-0.1.0 vs README.md in truemail-rspec-0.1.1
- old
+ new
@@ -13,10 +13,11 @@
- [Configuration instance with default random params](#configuration-instance-with-default-random-params)
- [Configuration instance with predefined params](#configuration-instance-with-predefined-params)
- [Create validator instance](#create-validator-instance)
- [create_servers_list](#create_servers_list)
- [create_validator DSL](#create_validator-dsl)
+- [Truemail family](#truemail-family)
- [Contributing](#contributing)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
- [Versioning](#versioning)
- [Changelog](CHANGELOG.md)
@@ -29,18 +30,20 @@
## Installation
Add this line to your application's Gemfile:
```ruby
-group :test do
- gem 'truemail-rspec'
+group :development, :test do
+ gem 'truemail-rspec', require: false
end
```
And add into your `spec_helper.rb` or `rails_helper.rb`:
```ruby
+require 'truemail/rspec'
+
RSpec.configure do |config|
config.include Truemail::RSpec
end
```
@@ -88,20 +91,28 @@
#### create_validator DSL
```ruby
create_validator(
- validation_type, # optional, :regex, :mx, :smtp, by default creates :smtp validation
- email, # optional, by default random email
- mail_servers, # optional, by default array with random ip addresses
- success: true, # optional, by default true
- configuration: create_configuration # optional, by default creates random configuration
+ validation_type, # optional, type:Symbol, can be :regex, :mx or :smtp, by default creates :smtp validation
+ email, # optional, type:String, by default random email
+ mail_servers, # optional, type:Array(String), by default array with random ip addresses
+ success: true, # optional, type:Bool, by default true
+ configuration: create_configuration # optional, type:Truemail::Configuration, by default creates random configuration
)
# => returns Truemail::Validator instance follow passed params
```
---
+
+## Truemail family
+
+All Truemail extensions: https://github.com/truemail-rb
+
+### truemail
+
+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).