docs: add content to README.md (#14)

* docs: add content to README.md Signed-off-by: Guillaume Belanger <[email protected]> * docs: add missing image Signed-off-by: Guillaume Belanger <[email protected]> * chore: add image license Signed-off-by: Guillaume Belanger <[email protected]> --------- Signed-off-by: Guillaume Belanger <[email protected]>
omec-project · Nov 20, 2024 · 09ed1fc · 09ed1fc
1 parent 5c35284
commit 09ed1fc
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,8 +1,12 @@
 <!--
 SPDX-FileCopyrightText: 2024 Intel Corporation
-
+SPDX-FileCopyrightText: 2024 Canonical Ltd.
 SPDX-License-Identifier: Apache-2.0
 -->
 <!-- [![Go Report Card](https://goreportcard.com/badge/github.com/omec-project/upfadapter)](https://goreportcard.com/report/github.com/omec-project/upfadapter) -->
 
 # upfadapter
+
+`upfadapter` is required to scale the SMF's in SD-Core. The SMF sends custom PFCP messages to `upfadapter`, which intercepts and modifies specific fields before sending the messages to the UPF. 
+
+![alt text](image.png)
diff --git a/image.png b/image.png
diff --git a/image.png.license b/image.png.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Canonical Ltd.
+
+SPDX-License-Identifier: Apache-2.0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		SPDX-FileCopyrightText: 2024 Canonical Ltd.

		SPDX-License-Identifier: Apache-2.0