MiningTcup/noteserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
MiningTcup
2025-08-14 20:16:17 -07:00
parent bf74391cbc
commit be3daeb2e5
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -3,4 +3,9 @@
Server for Notes
## Usage
The server, being a simple binary, can be deployed easily in several ways. The recommended method is using Docker. To do so, simply run ``docker-deploy.sh``. This will build the docker image and run the server on port 3002.
This program is intended for and tested on Linux, but may work on other systems. The server, being a simple binary, can be deployed easily in several ways. The recommended method is using Docker. Simply run ``docker-deploy.sh``. This will build the docker image and run the server on port 3002.
```
git clone ssh://git@git.miningtcup.me:222/MiningTcup/noteserver.git
cd noteserver
./docker-deploy.sh
```