diff --git a/README.md b/README.md index c651c77..7d4387e 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -PixelHosting IP show scripts. \ No newline at end of file +# PixelHosting ip.pixelhosting.nl + +```cd /opt && git clone https://git.pixelhosting.nl/PixelHosting/ip-show.git``` + +### App config +1. ```apt install -y python3 python3-uvicorn``` +2. ```cp ip-api.service /etc/systemd/system``` +3. ```sudo systemctl daemon-reload && sudo systemctl enable ip-api.service && sudo systemctl start ip-api.service``` + +## License + +```This project is licensed under the Apache License 2.0 with the Commons Clause restriction.``` + +```You may use, modify, and distribute this work for personal and non-commercial purposes only.``` + +**You must provide a clear link or reference to the original project when redistributing or using this work.** + +```Commercial use is strictly prohibited.``` \ No newline at end of file