From 21b34c8fa3df19815b6316738ec0c9034f77d358 Mon Sep 17 00:00:00 2001
From: "CTFang@WireLab" <ctfang.cs12@nycu.edu.tw>
Date: Fri, 5 Jul 2024 03:47:55 +0000
Subject: [PATCH] feat: add README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b05c0d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# NF-Example
+
+This repository is a sample NF for a simple HTTP service!
+Try adding more services and learn how to collaborate using GitHub.
+
+## Compile & Run
+
+```sh
+make
+./bin/nf -c config/nf.cfg
+```
+
+## Try Service
+
+```sh
+> curl -X GET http://127.0.0.163:8000/default/
+"Hello free5GC!"
+
+> curl -X GET http://127.0.0.163:8000/spyfamily/
+"Hello SPYxFAMILY!"
+
+> curl -X GET http://127.0.0.163:8000/spyfamily/character/Loid
+"Character: Loid Forger"
+```