feat: add README

andy89923 · Jul 5, 2024 · 21b34c8 · 21b34c8
1 parent 0a7bdad
commit 21b34c8
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md 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"
+```