From 3bbb8491ddac95607eca1deb3d0864cf2a11b074 Mon Sep 17 00:00:00 2001
From: medusa <herui@stblog.com.cn>
Date: Tue, 27 Aug 2024 17:50:26 +0800
Subject: [PATCH] add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8617827
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Single Player Tarkov - Server Project(community)
+
+This repository is for compiling the SPT server, not for source code. It automatically compiles the SPT code daily at midnight and pushes the compiled version to the releases. The compiled `.zip` file is intended for use with Windows. If you need the Linux version, please refer to the tutorial below.
+
+You also can find lanucher and modules from [here](https://dev.sp-tarkov.com/medusa/spt-build-ci/releases)
+
+[![SPT-Server Build Nightly On Schedule](https://github.com/AirryCo/spt-server-ci/actions/workflows/build-nightly-cron.yaml/badge.svg)](https://github.com/AirryCo/spt-server-ci/actions/workflows/build-nightly-cron.yaml)
+
+[![SPT-Server Manual Build](https://github.com/AirryCo/spt-server-ci/actions/workflows/build-nightly-manual.yaml/badge.svg)](https://github.com/AirryCo/spt-server-ci/actions/workflows/build-nightly-manual.yaml)
+
+## How to use
+
+### For windows
+
+1. go to https://github.com/AirryCo/spt-server-ci/releases
+
+2. download the `.zip` file
+
+3. use extraction software to unzip the files
+
+4. then run `SPT.Server.exe`
+
+5. run `SPT.Launcher` to connect
+
+### For linux
+
+repository(community): https://dev.sp-tarkov.com/medusa/spt-server
+
+registry: https://dev.sp-tarkov.com/medusa/-/packages/container/spt-server/nightly
+
+Docker Hub: https://hub.docker.com/r/stblog/spt-server
+
+1. use docker shell
+
+```bash
+docker pull dev.sp-tarkov.com/medusa/spt-server:nightly
+docker run -d --name spt-server -v ./spt-server:/opt/spt-server -e backendIp=192.168.1.1 -e backendPort=6969 -p 6969:6969 dev.sp-tarkov.com/medusa/spt-server:nightly
+```
+
+2. or use docker compose
+
+```yaml
+services:
+  spt-server:
+    image: dev.sp-tarkov.com/medusa/spt-server:nightly
+    container_name: spt-server
+    hostname: spt-server
+    restart: unless-stopped
+    volumes:
+      - ./spt-server:/opt/spt-server
+    network_mode: host
+    environment:
+      - backendIp=192.168.1.1
+      - backendPort=6969
+```
+