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

49 lines
1.4 KiB
Markdown

> Package captcha provides an easy to use, unopinionated API for captcha generation
<div>
[![GoDoc](https://godoc.org/github.com/steambap/captcha?status.svg)](https://godoc.org/github.com/steambap/captcha)
[![Build Status](https://travis-ci.org/steambap/captcha.svg)](https://travis-ci.org/steambap/captcha)
[![codecov](https://codecov.io/gh/steambap/captcha/branch/master/graph/badge.svg)](https://codecov.io/gh/steambap/captcha)
[![Go Report Card](https://goreportcard.com/badge/github.com/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://godoc.org/github.com/steambap/captcha) |
[example](example/basic/main.go)
## sample image
![image](example/captcha.png)
![image](example/captcha-math.png)
## Contributing
If your found a bug, please contribute!
see [contributing.md](contributing.md) for more detail
## License
[MIT](LICENSE.md)