aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNavan Chauhan <navanchauhan@gmail.com>2023-12-09 20:58:06 -0700
committerNavan Chauhan <navanchauhan@gmail.com>2023-12-09 20:58:06 -0700
commitdf466eba1bd4c9728fdb66e1a5fcf0e89203cf39 (patch)
tree934efd404f137d842611e727c0aa284c60f0f3c3
parentdd9102d8c0477afef5ad8e72662ce1d3f6191182 (diff)
add instructions to generate docs
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
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