aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-06-24 18:15:36 -0700
committerFuwn <[email protected]>2024-06-24 18:15:36 -0700
commit501287ba77b925ca4bbb5b2a3e4ef790b728e355 (patch)
tree4e43bb2e5cbf9fb47ef694ddca13a8e6eb8dc213
parent34e8da2ffea26f3994c84170533c897ef3cfcfa7 (diff)
downloadgigi-501287ba77b925ca4bbb5b2a3e4ef790b728e355.tar.xz
gigi-501287ba77b925ca4bbb5b2a3e4ef790b728e355.zip
docs(readme): add example usagev0.1.0
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 13e0f09..6dd6571 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,19 @@ Gigi is a Finger protocol server with few features.
## Usage
+A live, production deployment of Gigi exists at
+[`finger://fuwn.me`](finger://fuwn.me). Feel free to poke and prod at it as you
+wish.
+
+You can use a Finger client like [finger](https://github.com/reiver/finger) to
+send requests, or you could use the old reliable `telnet` or `nc` commands.
+
+```bash
+$ finger fuwn.me
+$ telnet fuwn.me
+$ echo -e "" | nc fuwn.me 79
+```
+
### Local
```bash