Add a real README
All checks were successful
Build and Publish ipserv / build_and_publish (push) Successful in 13s

This commit is contained in:
Nexus 2024-04-22 03:00:20 +01:00
parent 4e0cf1bd98
commit e92d2239aa
Signed by: nex
GPG key ID: 0FA334385D0B689F

12
README.md Normal file
View file

@ -0,0 +1,12 @@
# IPServ
A [SHRoNK IP server](https://github.com/SHRoNK-Corporation/shronk-ip-spec) that piggybacks off of the
[reference server](https://github.com/SHRoNK-Corporation/shronk-ip), written in python.
## Installing
See [INSTALL.md](INSTALL.md) for installation instructions. It is extremely recommended you use docker.
## Usage
See: [https://ip.i-am.nexus](https://ip.i-am.nexus) (docs: [https://ip.i-am.nexus/docs](https://ip.i-am.nexus/docs))