From e5cf3452735749a42f9d7fb89803f3acf59fd16e Mon Sep 17 00:00:00 2001 From: Adnan Maolood Date: Wed, 24 Mar 2021 13:30:46 -0400 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 547c485..c18ce5f 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![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?) -Package gemini implements the [Gemini protocol](https://gemini.circumlunar.space) in Go. - -It provides an API similar to that of net/http to make it easy to develop Gemini clients and servers. +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. Compatible with version v0.14.3 of the Gemini specification. @@ -12,6 +12,9 @@ Compatible with version v0.14.3 of the Gemini specification. import "git.sr.ht/~adnano/go-gemini" +Note that some filesystem-related functionality is only available on Go 1.16 +or later as it relies on the io/fs package. + ## Examples There are a few examples provided in the examples directory. @@ -24,3 +27,9 @@ To run an example: 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). + +## 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.