README.md in email_detected-0.1.2 vs README.md in email_detected-0.1.3
- old
+ new
@@ -1,9 +1,9 @@
# Email Detected
-[](https://www.codacy.com/app/quanmn.libra/email_detected_2?utm_source=github.com&utm_medium=referral&utm_content=minhquan4080/email_detected&utm_campaign=badger)
-[](https://circleci.com/gh/minhquan4080/email_detected/tree/master)
+[](https://www.codacy.com/app/quanmn.libra/email_detected_2?utm_source=github.com&utm_medium=referral&utm_content=dereknguyen269/email_detected&utm_campaign=badger)
+[](https://circleci.com/gh/dereknguyen269/email_detected/tree/master)
Email Detected is a simple tool for verifying an email address exists. It's free and quite easy to use :smile: .
Many times as developers we were putting validation statements for checking email addresses format. This gem will complete your existing setups with validator that actually connects with a given mail server and asks if the address in question exists for real.
@@ -31,32 +31,43 @@
First thing you need to set up is placing something like this either in initializer or in application.rb file:
```ruby
EmailDetected.config do |config|
- config.verifier_email = "youremail@email.com"
+ config.verifier_email = ENV['SENDER_EMAIL_DETECTED']
end
```
+Then, adding your **env** config with:
+
+```bash
+SENDER_EMAIL_DETECTED=your-real-email-config
+```
+
+Note: `verifier_email` must be **real**.
+
Then just put this in your model e. g:
```ruby
validates_exist_email_of :email
```
+
Or - if you'd like to use it outside of your models:
```ruby
EmailDetected.exist?(youremail)
```
This method will return with status `true || false` and `message` look like:
+
```
-{:status=>true, :message=>"The email address has already been registered."}
+{:status=>true, :message=>"The email address has already been registered."}
```
```
-{:status=>false, :message=>"The email address invalid."}
+{:status=>false, :message=>"The email address invalid."}
```
+
or will throw an exception with nicely detailed info about what's wrong.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.