README.md in botscout-0.0.1 vs README.md in botscout-0.0.2
- old
+ new
@@ -1,8 +1,7 @@
-# Botscout
+# Botscout [](https://travis-ci.org/parallel588/botscout)
-TODO: Write a gem description
## Installation
Add this line to your application's Gemfile:
@@ -16,10 +15,17 @@
$ gem install botscout
## Usage
-TODO: Write usage instructions here
+ botscout = Botscout::Client.new("key")
+ result = botscout.test mail: email
+ if result.success?
+ Logger.info "Email address is spam: #{email}" if result.bot?
+ else
+ Logger.info "Servis is not available: #{result.error}"
+ end
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)