From e92d2239aa0a5e0a8c40884a61a0a0df89278a2e Mon Sep 17 00:00:00 2001 From: nexy7574 Date: Mon, 22 Apr 2024 03:00:20 +0100 Subject: [PATCH] Add a real README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e858b06 --- /dev/null +++ b/README.md @@ -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))