This repository has been archived on 2024-08-25. You can view files and clone it, but cannot push or open issues or pull requests.
captcha/README.md

52 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2018-04-26 03:03:29 +01:00
> Package captcha provides an easy to use, unopinionated API for captcha generation.
2017-09-20 02:51:27 +01:00
<div>
2024-07-10 16:45:11 +01:00
[![PkgGoDev](https://pkg.go.dev/badge/concord.hectabit.org/HectaBit/captcha)](https://pkg.go.dev/concord.hectabit.org/HectaBit/captcha)
[![Go Report Card](https://goreportcard.com/badge/concord.hectabit.org/HectaBit/captcha)](https://goreportcard.com/report/concord.hectabit.org/HectaBit/captcha)
</div>
2017-10-05 15:00:16 +01:00
## Why another captcha generator?
2024-05-02 00:24:46 +01:00
Because I can.
2017-10-05 15:00:16 +01:00
## install
```
2024-07-10 16:45:11 +01:00
go get concord.hectabit.org/HectaBit/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)
}
```
2024-07-10 16:45:11 +01:00
[documentation](https://pkg.go.dev/concord.hectabit.org/HectaBit/captcha) |
2021-09-28 09:44:12 +01:00
[example](example/basic/main.go) |
[font example](example/load-font/main.go)
## sample image
![image](example/captcha.png)
![image](example/captcha-math.png)
2021-06-22 07:13:41 +01:00
## Compatibility
2021-07-28 14:26:53 +01:00
This package uses embed package from Go 1.16. If for some reasons you have to use pre 1.16 version of Go, reference pre 1.4 version of this module in your go.mod.
2021-06-22 07:13:41 +01:00
## Contributing
If your found a bug, please contribute!
2018-04-26 03:03:29 +01:00
see [contributing.md](contributing.md) for more detail.
## License
2020-01-13 07:18:25 +00:00
[MIT](LICENSE)