From df466eba1bd4c9728fdb66e1a5fcf0e89203cf39 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Sat, 9 Dec 2023 20:58:06 -0700 Subject: add instructions to generate docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 291e6a0..e237947 100644 --- a/README.md +++ b/README.md @@ -103,4 +103,10 @@ Although, `swift-gopher` does not currently have a native HTTP handler, you can - [ ] Verify Compatibility with other Gopher Clients - [ ] Support Gemini Protocol - [ ] Add a client library -- [ ] Add native HTTP handler \ No newline at end of file +- [ ] Add native HTTP handler + +## Generating Docs + +```bash +swift package --allow-writing-to-directory docs generate-documentation --transform-for-static-hosting --target swift-gopher --output-path docs --hosting-base-path swift-gopher +``` \ No newline at end of file -- cgit v1.2.3