aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3275b98..1d09ba6 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Maple
A very simple static Gemini server; written within a single file and liberally
-spanning 135 lines-of-code.
+spanning 152 lines-of-code.
## Usage
@@ -37,6 +37,20 @@ field which should be modified is the `ports`, if you have to.
1. Build: `ninja` (requires [Ninja](https://ninja-build.org/))
2. Run: `out/maple`
+### Hacking
+
+If you decide to tamper with Maple, you should give your commits a test. As
+there isn't a test suite yet, feel free to use any of these examples:
+
+```bash
+# Using OpenSSL directly to debug different requests:
+$ openssl s_client -ign_eof -quiet -connect localhost:1965 <<< \
+> "gemini://localhost:1965"
+
+# Using Bollux to debug proper requests... or any client!
+$ bollux localhost
+```
+
## Capsules using Maple
[Add yours!](https://github.com/gemrest/maple/edit/main/README.md)