Add a real README
All checks were successful
Build and Publish ipserv / build_and_publish (push) Successful in 13s
All checks were successful
Build and Publish ipserv / build_and_publish (push) Successful in 13s
This commit is contained in:
parent
4e0cf1bd98
commit
e92d2239aa
1 changed files with 12 additions and 0 deletions
12
README.md
Normal file
12
README.md
Normal 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))
|
Reference in a new issue