2020-10-24 21:15:32 +02:00
|
|
|
# go-gemini
|
2020-09-21 21:48:42 +02:00
|
|
|
|
2021-02-16 06:07:01 +01: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-22 00:28:34 +02:00
|
|
|
|
2023-12-25 16:43:54 +01:00
|
|
|
Package gemini implements the [Gemini protocol](https://geminiprotocol.net)
|
2021-03-24 18:30:46 +01:00
|
|
|
in Go. It provides an API similar to that of net/http to facilitate the
|
|
|
|
development of Gemini clients and servers.
|
2020-09-21 21:48:42 +02:00
|
|
|
|
2021-12-18 18:51:04 +01:00
|
|
|
Compatible with version v0.16.0 of the Gemini specification.
|
2021-02-09 21:49:53 +01:00
|
|
|
|
2020-10-24 22:58:35 +02:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
import "git.sr.ht/~adnano/go-gemini"
|
|
|
|
|
2021-03-24 18:30:46 +01:00
|
|
|
Note that some filesystem-related functionality is only available on Go 1.16
|
|
|
|
or later as it relies on the io/fs package.
|
|
|
|
|
2020-09-21 23:23:51 +02:00
|
|
|
## Examples
|
2020-09-21 21:48:42 +02:00
|
|
|
|
2020-10-25 02:55:58 +01:00
|
|
|
There are a few examples provided in the examples directory.
|
|
|
|
To run an example:
|
2020-09-21 21:48:42 +02:00
|
|
|
|
2020-10-12 22:39:01 +02:00
|
|
|
go run examples/server.go
|
2020-10-25 02:55:58 +01:00
|
|
|
|
2021-03-24 18:30:46 +01:00
|
|
|
## License
|
|
|
|
|
|
|
|
go-gemini is licensed under the terms of the MIT license (see LICENSE).
|
|
|
|
Portions of this library were adapted from Go and are governed by a BSD-style
|
|
|
|
license (see LICENSE-GO). Those files are marked accordingly.
|