2020-10-24 19:15:32 +00:00
|
|
|
# go-gemini
|
2020-09-21 19:48:42 +00:00
|
|
|
|
2023-05-26 04:45:08 +00:00
|
|
|
This repository is a fork of [go-gemini](https://godocs.io/git.sr.ht/~adnano/go-gemini)
|
|
|
|
|
implementing better parity with net/http and some tweaks required for use in
|
|
|
|
|
[Hnakra](https://git.tebibyte.media/sashakoshka/hnakra).
|
|
|
|
|
|
2021-03-24 17:30:46 +00:00
|
|
|
Package gemini implements the [Gemini protocol](https://gemini.circumlunar.space)
|
|
|
|
|
in Go. It provides an API similar to that of net/http to facilitate the
|
|
|
|
|
development of Gemini clients and servers.
|
2020-09-21 19:48:42 +00:00
|
|
|
|
2021-12-18 17:51:04 +00:00
|
|
|
Compatible with version v0.16.0 of the Gemini specification.
|
2021-02-09 20:49:53 +00:00
|
|
|
|
2020-10-24 20:58:35 +00:00
|
|
|
## Usage
|
|
|
|
|
|
2023-05-25 22:27:52 +00:00
|
|
|
import "git.tebibyte.media/sashakoshka/go-gemini"
|
2020-10-24 20:58:35 +00:00
|
|
|
|
2021-03-24 17:30:46 +00: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 21:23:51 +00:00
|
|
|
## Examples
|
2020-09-21 19:48:42 +00:00
|
|
|
|
2020-10-25 01:55:58 +00:00
|
|
|
There are a few examples provided in the examples directory.
|
|
|
|
|
To run an example:
|
2020-09-21 19:48:42 +00:00
|
|
|
|
2020-10-12 20:39:01 +00:00
|
|
|
go run examples/server.go
|
2020-10-25 01:55:58 +00:00
|
|
|
|
2021-03-24 17:30:46 +00: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.
|
