aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-06-24 21:45:34 -0700
committerGitHub <[email protected]>2024-06-24 21:45:34 -0700
commite2f2c11a25b6e30254813a1ab16cd2893a2790a3 (patch)
tree61218fd581294fe1ff6885b3d526505a34bc42b9
parent501287ba77b925ca4bbb5b2a3e4ef790b728e355 (diff)
downloadgigi-e2f2c11a25b6e30254813a1ab16cd2893a2790a3.tar.xz
gigi-e2f2c11a25b6e30254813a1ab16cd2893a2790a3.zip
docs(readme): update information
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6dd6571..21cfc5e 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
# 👧️ Gigi
-> A Finger protocol server for risk takers
+> A [Finger](https://www.rfc-editor.org/info/rfc742) protocol server for risk takers
Gigi is a Finger protocol server with few features.
-- Gigi can respond to Finger requests statically
-- Gigi can respond to Finger requests dynamically
+- Gigi can respond to Finger requests statically.
+- Gigi can respond to Finger requests dynamically.
<p align="center">
<br>
@@ -24,7 +24,7 @@ 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
+$ echo | nc fuwn.me 79
```
### Local
@@ -79,8 +79,9 @@ contents of `./gigi/test`. A Finger request of nothing will return the contents
of `./gigi/default`. The default file is also the fallback file in case the
requested file does not exist.
-To emulate dynamic mode, minus the arguments you can setup a service of some
-kind to periodically update the contents of one of the static files.
+To emulate dynamic mode, minus the support for arguments, you can setup a
+service of some kind to periodically update the contents of one of the static
+files.
## Licence