Skip to content

Commit 48b57f9

Browse files
authored
Update README.md
1 parent ae14388 commit 48b57f9

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,31 @@ $ php artisan vendor:publish --provider="TimeHunter\LaravelGoogleReCaptchaV3\Pro
116116

117117
After installation, you should see a googlerecaptchav3.php in your app/config folder, and vue component under js/components/googlerecaptchav3 folder.
118118

119+
## Configurations <a name="settings" />
120+
### Setting up your Google reCAPTCHA details in config file
121+
122+
Please register all details in config for host_name, site_key, secret_key and site_verify_url.
123+
124+
Specify your Score threshold and action in 'setting', e.g.
125+
``` php
126+
'setting' = [
127+
[
128+
'action' => 'contact_us', // Google reCAPTCHA required paramater
129+
'threshold' => 0.2, // score threshold
130+
'is_enabled' => false // if this is true, the system will do score comparsion against your threshold for the action
131+
]
132+
]
133+
```
134+
Note: if you want to enable Score Comparision, you also need to enable is_score_enabled to be true.
135+
``` php
136+
'is_score_enabled' = true
137+
```
138+
139+
For score comparision, all actions should be registered in googlerecaptchav3 config file under 'setting' section.
140+
141+
For more details please check comments in config file.
142+
143+
119144

120145
## Facade Usage <a name="facade-usage" />
121146

@@ -179,30 +204,6 @@ If you manually assign a value to setScore($score), the code will fully skip you
179204

180205

181206

182-
## Configurations <a name="settings" />
183-
### Setting up your Google reCAPTCHA details in config file
184-
185-
Please register all details in config for host_name, site_key, secret_key and site_verify_url.
186-
187-
Specify your Score threshold and action in 'setting', e.g.
188-
``` php
189-
'setting' = [
190-
[
191-
'action' => 'contact_us', // Google reCAPTCHA required paramater
192-
'threshold' => 0.2, // score threshold
193-
'is_enabled' => false // if this is true, the system will do score comparsion against your threshold for the action
194-
]
195-
]
196-
```
197-
Note: if you want to enable Score Comparision, you also need to enable is_score_enabled to be true.
198-
``` php
199-
'is_score_enabled' = true
200-
```
201-
202-
For score comparision, all actions should be registered in googlerecaptchav3 config file under 'setting' section.
203-
204-
For more details please check comments in config file.
205-
206207
## Blade Usage <a name="blade-basic-usage" />
207208
### Display reCAPTCHA v3
208209

0 commit comments

Comments
 (0)