From 85f22d2098204226b27a3fa517781b5f23c984d7 Mon Sep 17 00:00:00 2001
From: lichang <lichang@qq.com>
Date: Tue, 12 Aug 2025 10:30:03 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4121cb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+<p align="center">
+  <a href="https://github.com/aligungr/UERANSIM"><img src="/.github/logo.png" width="75" title="UERANSIM"></a>
+</p>
+<p align="center">
+<img src="https://img.shields.io/badge/UERANSIM-v3.2.7-blue" />
+<img src="https://img.shields.io/badge/3GPP-R15-orange" />
+<img src="https://img.shields.io/badge/License-GPL--3.0-green"/>
+</p>
+
+**UERANSIM** <small>(pronounced "ju-i ræn sɪm")</small>, is the open source state-of-the-art 5G UE and RAN (gNodeB)
+simulator. UE and RAN can be considered as a 5G mobile phone and a base station in basic terms. The project can be used for
+testing 5G Core Network and studying 5G System.
+
+UERANSIM introduces the world's first open source 5G-SA UE and gNodeB implementation.
+
+> [!IMPORTANT]
+> UERANSIM is no longer actively developed by the maintainer. However community contributions are welcomed.
+
+## Current Status
+
+Basic functionalities of UE and gNodeB are fully functional and ready to use. However some of the features are not complete.
+More details can be found at [Feature Set](https://github.com/aligungr/UERANSIM/wiki/Feature-Set).
+
+On the other hand, UERANSIM does not fully provide physical layer. 5G-NR radio interface is partially implemented, and simply simulated over UDP protocol.
+
+<p align="center">
+<img src="https://img.shields.io/badge/Radio%20Interface-simulated-orange" alt="OS Linux"/>
+<img src="https://img.shields.io/badge/Control%20Plane-functional-green" alt="OS Linux"/>  
+<img src="https://img.shields.io/badge/User%20Plane-functional-green" alt="OS Linux"/>
+</p>
+
+## Documentation
+
+You can find the documentation on [UERANSIM Wiki](https://github.com/aligungr/UERANSIM/wiki).
+
+And, since the project is rapidly developing, please make sure that you have always
+the [latest](https://github.com/aligungr/UERANSIM/releases) UERANSIM.
+
+## Contributing
+
+Any contributions you make are greatly appreciated via [Pull Request](https://github.com/aligungr/UERANSIM/pulls).
+
+## Supporting
+
+You can support UERANSIM by:
+
+- Starring the GitHub repository,
+- Donating on [Open Collective](https://opencollective.com/UERANSIM)
+- Creating pull requests, submitting bugs, suggesting new features or documentation updates.
+
+## License
+
+Copyright (c) 2025 ALİ GÜNGÖR.
+
+All source code and related files including documentation and wiki pages are
+dual licensed with [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) and a commercial license.
+
+> [!WARNING]
+> Closed-source commercial usage of UERANSIM is **not** permitted with the GPL-3.0. If that license is not compatable with your use case, please contact [ueransim@gmail.com](mailto:ueransim@gmail.com) to buy a commercial license.
\ No newline at end of file