From 44632822e8ee7dbc7b679aaa070bacabba0a00b8 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Sun, 17 Dec 2023 02:44:15 -0700 Subject: update README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 98c1e3a..50171a0 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ # Swift-Gopher +* swift-gopher : Gopher server implementation written in Swift +* swiftGopherClient: Gopher client library written in Swift ( w/ Support for Network.Framework on Apple platforms) + +This package also provides GopherHelpers which may be useful while building a client. A PoC client for iOS/macOS/iPadOS called `iGopherBrowser` uses both `GopherHelpers` and `swiftGopherClient` + You can interact with my hosted gopher server at [gopher://gopher.navan.dev](gopher://gopher.navan.dev) or [https://gopher.navan.dev](https://gopher.navan.dev) ``` @@ -98,11 +103,11 @@ Although, `swift-gopher` does not currently have a native HTTP handler, you can - [ ] Add Tests - [ ] Add CI -- [ ] Add more documentation +- [x] Add more documentation - [ ] Automatic Versioning - [ ] Verify Compatibility with other Gopher Clients - [ ] Support Gemini Protocol -- [ ] Add a client library +- [x] Add a client library - [ ] Add native HTTP handler - [ ] Guestbook @@ -111,3 +116,7 @@ Although, `swift-gopher` does not currently have a native HTTP handler, you can ```bash ./generate_docs.sh swiftGopherClient swift-gopher GopherHelpers ``` + +### Reference Documentation + +Reference Documentation is hosted at [https://web.navan.dev/swift-gopher](https://web.navan.dev/swift-gopher) -- cgit v1.2.3