59 lines
1.6 KiB
Markdown
59 lines
1.6 KiB
Markdown
> Package captcha provides an easy to use, unopinionated API for captcha generation.
|
|
|
|
<div>
|
|
|
|
[](https://pkg.go.dev/github.com/steambap/captcha)
|
|
[](https://github.com/steambap/captcha/actions?workflow=CI)
|
|
[](https://codecov.io/gh/steambap/captcha)
|
|
[](https://goreportcard.com/report/github.com/steambap/captcha)
|
|
|
|
</div>
|
|
|
|
## Why another captcha generator?
|
|
I want a simple and framework-independent way to generate captcha. It also should be flexible, at least allow me to pick my favorite font.
|
|
|
|
## install
|
|
```
|
|
go get github.com/steambap/captcha
|
|
```
|
|
|
|
## usage
|
|
```Go
|
|
func handle(w http.ResponseWriter, r *http.Request) {
|
|
// create a captcha of 150x50px
|
|
data, _ := captcha.New(150, 50)
|
|
|
|
// session come from other library such as gorilla/sessions
|
|
session.Values["captcha"] = data.Text
|
|
session.Save(r, w)
|
|
// send image data to client
|
|
data.WriteImage(w)
|
|
}
|
|
|
|
```
|
|
|
|
[documentation](https://pkg.go.dev/github.com/steambap/captcha) |
|
|
[example](example/basic/main.go)
|
|
|
|
## sample image
|
|
|
|
|
|
|
|
|
|
## Compatibility
|
|
|
|
This package is in a module and I recommand using the following version of Go:
|
|
|
|
* 1.9.7+ for Go 1.9
|
|
* 1.10.3+ for Go 1.10
|
|
* Go 1.11 or later
|
|
|
|
## Benchmarks
|
|
|
|
## Contributing
|
|
If your found a bug, please contribute!
|
|
see [contributing.md](contributing.md) for more detail.
|
|
|
|
## License
|
|
[MIT](LICENSE)
|