gemini-browser

A text-based gemini browser
git clone git://git.laack.co/gemini-browser.git
Log | Files | Refs | README

README.md (2316B)

      1 # go-gemini
      2 
      3 [![Go Reference](https://pkg.go.dev/badge/github.com/makeworld-the-better-one/go-gemini.svg)](https://pkg.go.dev/github.com/makeworld-the-better-one/go-gemini)
      4 
      5 go-gemini is a library that provides an easy interface to create client ~~and servers~~ that speak the [Gemini protocol](https://gemini.circumlunar.space/).
      6 
      7 **Spec version supported:** v0.16.0, November 14th 2021
      8 
      9 This version of the library was forked from [~yotam/go-gemini](https://git.sr.ht/~yotam/go-gemini/) to add additional features, as well as update it to support newer specs. At the time of forking, it had not seen any new commit for 5 months, and was based on v0.9.2. If there are any future upstream updates, I will make an effort to include them.
     10 
     11 **The server part of this library has been removed.** I don't use it and don't want to maintain it.
     12 
     13 This is mostly a personal library. You might want to check out [go-gemini](https://sr.ht/~adnano/go-gemini) (no relation) for more features.
     14 
     15 ## Improvements
     16 This fork of the library improves on the original in several ways, some listed above already.
     17 
     18 - Client supports self-signed certs sent by the server, but still has other checks like expiry date and hostname
     19   - The original library could only work with self-signed certs by disabling all security.
     20 - Invalid status code numbers raise an error
     21 - Set default port and scheme for client requests
     22 - Raise error when META strings are too long in the response header
     23 - Supports new status code updates
     24 - If `SSLKEYLOGFILE` is set, session keys are written to the file in NSS format. This is useful for debugging TLS connections (but breaks security, so don't use unless necessary).
     25 - Support proxies
     26 - Support client certs
     27 - Add connection/header timeouts, and read timeouts
     28 - And more!
     29 
     30 ## Notes
     31 
     32 This library only works with Go 1.15 and higher.
     33 
     34 If you want relatively reliable code, use the latest tag, not the latest commit. Code in the latest master might be untested/buggy. The API might change between tags since it is still v0.
     35 
     36 ## License
     37 This library is under the ISC License, see the [LICENSE](./LICENSE) file for details. Portions of this library's code are taken from Go, and are under a different license, which can be found in [LICENSE-GO](./LICENSE-GO). Those files are marked accordingly in their comments.