go-gemini/README.md

27 lines
906 B
Markdown
Raw Normal View History

2020-10-24 13:15:32 -06:00
# go-gemini
2020-09-21 13:48:42 -06:00
2021-02-15 22:07:01 -07:00
[![godocs.io](https://godocs.io/git.sr.ht/~adnano/go-gemini?status.svg)](https://godocs.io/git.sr.ht/~adnano/go-gemini) [![builds.sr.ht status](https://builds.sr.ht/~adnano/go-gemini.svg)](https://builds.sr.ht/~adnano/go-gemini?)
2020-09-21 16:28:34 -06:00
2020-10-24 13:15:32 -06:00
Package gemini implements the [Gemini protocol](https://gemini.circumlunar.space) in Go.
2020-09-21 13:48:42 -06:00
2021-02-08 10:53:37 -07:00
It provides an API similar to that of net/http to make it easy to develop Gemini clients and servers.
2020-09-21 13:48:42 -06:00
Compatible with version v0.14.3 of the Gemini specification.
2020-10-24 14:58:35 -06:00
## Usage
import "git.sr.ht/~adnano/go-gemini"
2020-09-21 15:23:51 -06:00
## Examples
2020-09-21 13:48:42 -06:00
There are a few examples provided in the examples directory.
To run an example:
2020-09-21 13:48:42 -06:00
2020-10-12 14:39:01 -06:00
go run examples/server.go
## Contributing
Send patches and questions to [~adnano/go-gemini-devel](https://lists.sr.ht/~adnano/go-gemini-devel).
Subscribe to release announcements on [~adnano/go-gemini-announce](https://lists.sr.ht/~adnano/go-gemini-announce).