added readme

Author: RyanDaDeng

README.md

@@ -2,43 +2,141 @@
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
 [![Total Downloads][ico-downloads]][link-downloads]
-[![Build Status][ico-travis]][link-travis]
-[![StyleCI][ico-styleci]][link-styleci]
 
-This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list.
+
+## Features
+
+- Score Comparision
+- Support multiple input field for different <form> tag
+- Support custom implementation on config interface
+- Support custom implementation on request method interface 
+
+## Requirement
+
+This package requires the following dependencies:
+
+- Laravel 5.x
+
+- php > 5
+
+- Please ensure that you have read basic information from Google reCAPTCHA v3.
 
 ## Installation
 
+
 Via Composer
 
 ``` bash
 $ composer require ryandeng/googlerecaptcha
 ```
 
-## Usage
+If your Laravel framework version <= 5.4, please register the service provider in your config file: /config/app.php, otherwise please go to step 3.
+
+```sh
+Ryandadeng\Securepayframe\SecurePayFrameServiceProvider::class
+```
+
+If your Laravel framework version is >= 5.5, just run the following command to publish views and config.
+```sh 
+php artisan vendor:publish --provider="RyanDeng\GoogleReCaptcha\GoogleReCaptchaServiceProvider"
+```
 
-## Change log
+After installation, you should see a googlerecaptcha/googlerecaptcha.blade file in your views folder and googlerecaptchav3.php in your app/config folder.
 
-Please see the [changelog](changelog.md) for more information on what has changed recently.
+If you want to change the default template, please check Advanced Usage.
 
-## Testing
 
-``` bash
-$ composer test
+## Basic Usage
+#### Setting up your Google reCAPTCHA details
+
+Please register all details on host_name, site_key, secret_key and site_verify_url.
+
+Specify your Score threshold in score_setting, e.g.
+
+        [
+            'action' => 'contact_us', // Google reCAPTCHA required paramater
+            'id' => 'contactus_id', // your HTML input field id
+            'threshold' => 0.2, // score threshold
+            'is_enabled' => false // if this is true, the system will do score comparsion against your threshold for the action
+        ]
+        
+Note: if you want to enable Score Comparision, you also need to enable is_score_enabled to be true.
+
+Remember to turn on the service by enable is_service_enabled to be true.
+
+For more details please check comments in config file. 
+        
+#### Validation Class
+   
+   You can use provided Validation object to verify your reCAPTCHA.
+      
+``` php
+   use RyanDeng\GoogleReCaptcha\Validations\GoogleReCaptchaValidationRule
+   $rule = [
+            'g-recaptcha-response' => [new GoogleReCaptchaValidationRule('action_name',$ip)]
+        ];
+```
+
+   'g-recaptcha-response' is the name of your <input> field, which is currently hard-coded.
+   
+   GoogleReCaptchaValidationRule($actionName, $ip) which accepts two optional parameters:
+   -  $actionName: if its NULL, the package won't verify action with google response.
+   
+   -  $ip: request remote ip, this is Google reCAPTCHA parameter.
+   
+
+#### Facade Class
+
+$action: Google reCAPTCHA definition
+
+$response: which is a value comes from g-recaptcha-response
+
+$ip: optional
+
+GoogleReCaptcha::setAction($action)->verifyResponse($response, $ip);
+    
+## Advanced Usage
+
+#### Custom implementation on Config
+    
+For some users, they might store the config details in their own storage e.g database. You can create your own class and implement:
+
+```
+RyanDeng\GoogleReCaptcha\Interfaces\ReCaptchaConfigInterface
+```
+
+Remember to register your implementation, e.g.
+
+``` php
+     $this->app->bind(
+                ReCaptchaConfigInterface::class,
+                YourOwnCustomImplementation::class
+            );
+```
+
+#### Custom implementation on Request method
+
+The package uses Curl to verify, if you want to use your own request method, You can create your own class and implement 
+```
+RyanDeng\GoogleReCaptcha\Interfaces\RequestClientInterface
 ```
 
-## Contributing
+Remember to register your implementation.
+``` php
+     $this->app->bind(
+                RequestClientInterface::class,
+                YourOwnCustomImplementation::class
+            );
+```
+## Testing
+
+This test file will be added in the next release.
 
-Please see [contributing.md](contributing.md) for details and a todolist.
 
 ## Security
 
 If you discover any security related issues, please email ryandadeng@gmail.com instead of using the issue tracker.
 
-## Credits
-
-- [Ryan Deng][link-author]
-- [All Contributors][link-contributors]
 
 ## License
 
@@ -51,6 +149,4 @@ MIT. Please see the [license file](license.md) for more information.
 
 [link-packagist]: https://packagist.org/packages/ryandeng/googlerecaptcha
 [link-downloads]: https://packagist.org/packages/ryandeng/googlerecaptcha
-[link-travis]: https://travis-ci.org/ryandeng/googlerecaptcha
-[link-styleci]: https://styleci.io/repos/12345678
 [link-author]: https://github.com/ryandadeng