From 1dc4d16543a8948b60b81e820a7cce032fbff698 Mon Sep 17 00:00:00 2001
From: pm47 <pm.padiou@gmail.com>
Date: Thu, 21 Mar 2024 15:13:53 +0100
Subject: [PATCH] add basic README

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e947f2c..4965606 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-# phoenixd
\ No newline at end of file
+[![Kotlin](https://img.shields.io/badge/Kotlin-1.9.21-blue.svg?style=flat&logo=kotlin)](http://kotlinlang.org)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![](https://img.shields.io/badge/www-Homepage-green.svg)](https://phoenix.acinq.co/server)
+[![](https://img.shields.io/badge/www-API_doc-red.svg)](https://phoenix.acinq.co/server/api)
+
+# phoenixd
+
+**phoenixd** is the server equivalent of the popular [phoenix wallet](https://github.com/ACINQ/phoenix) for mobile.
+It is written in [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) and runs natively on Linux, MacOS (x86 and ARM), and Windows (WSL).
+
+## Build
+
+### Linux/WSL
+
+```shell
+./gradlew packageLinuxX64
+```
+
+### MacOS x64
+```shell
+./gradlew packageMacOSX64
+```
+
+### MacOS arm64
+```shell
+./gradlew packageMacOSArm64
+```