Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wenlng committed Nov 25, 2021
1 parent 083a88b commit b4706ef
Showing 1 changed file with 19 additions and 24 deletions.
43 changes: 19 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# go-captcha
Package captcha implements generation and click location verification of image CAPTCHAs.

# go-captcha - Behavioral Verification Code

[![License](https://img.shields.io/github/license/wenlng/go-captcha.svg)](https://github.com/wenlng/go-captcha/blob/master/LICENSE)
[![Version](https://img.shields.io/github/tag/wenlng/go-captcha.svg)](https://github.com/wenlng/go-captcha/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/wenlng/go-captcha)](https://goreportcard.com/report/github.com/wenlng/go-captcha)
[![GoDoc](https://godoc.org/github.com/wenlng/go-captcha?status.svg)](https://godoc.org/github.com/wenlng/go-captcha)
[![License](https://img.shields.io/github/license/wenlng/go-captcha.svg)](https://github.com/wenlng/go-captcha/blob/master/LICENSE)

Package captcha implements generation and click location verification of image CAPTCHAs.

- Github:[https://github.com/wenlng/go-captcha](https://github.com/wenlng/go-captcha)
- Example Code:[https://github.com/wenlng/go-captcha-example](https://github.com/wenlng/go-captcha-example)
Expand All @@ -23,21 +23,15 @@ Package captcha implements generation and click location verification of image C
<br/>
<br/>
</div>
<br>

- Installation of proxy go module in China
>
>GoProxy https://github.com/goproxy/goproxy.cn
>
>AliProxy: https://mirrors.aliyun.com/goproxy/
>
>OfficialProxy: https://goproxy.io/
>
>ChinaProxy:https://goproxy.cn
>
>Other:https://gocenter.io
### Set Proxy of Go module

## Installation of proxy go module in China
- GoProxy https://github.com/goproxy/goproxy.cn
- AliProxy: https://mirrors.aliyun.com/goproxy/
- OfficialProxy: https://goproxy.io/
- ChinaProxy:https://goproxy.cn
- Other:https://gocenter.io

#### Set Proxy of go module
- Window
```shell script
set GO111MODULE=on
Expand Down Expand Up @@ -78,7 +72,7 @@ func main(){
}
```

### Quick use
### Quick Use
The SetFont and SetBackground configuration must be set
<br/>
You can copy the resource files under the "__example/resources" to the directory of your project
Expand Down Expand Up @@ -132,7 +126,7 @@ func main(){

```

### Method Instructions
### Captcha Instances
- New Instances or Get Single Instances
```go
package main
Expand All @@ -154,7 +148,8 @@ func main(){
}
```

- Set Chars
### Set Configuration
#### Set Chars
```go
package main
import (
Expand Down Expand Up @@ -186,7 +181,7 @@ func main(){
}
```

### Set configuration
#### Set image configuration
```go
package main
import (
Expand Down Expand Up @@ -379,7 +374,7 @@ func main(){
}
```

### Fronted Example Api Params
### Api Params Of Fronted Example
```
// Example: Get captcha data
API = http://....../captcha/captcha-data
Expand Down

0 comments on commit b4706ef

Please sign in to comment.