add basic README

This commit is contained in:
pm47 2024-03-21 15:13:53 +01:00
parent 91e1ea6055
commit 1dc4d16543
No known key found for this signature in database
GPG Key ID: E434ED292E85643A

View File

@ -1 +1,27 @@
[![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
**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
```