diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0fd43bf --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Linea Caliente + +A hotline protocol server and library written in rust. + +Everything is under construction, so unless this message isn't here, anything +below this is aspirational rather than reflective of reality. + +## Using as a Server + +You can use linea caliente as a stand-alone server. The default command is: + +``` +linea-caliente +``` + +This will listen on 127.0.0.1:5500. You can specify the address to listen +with the `-l` / `--listen-address` flag. + +``` +linea-caliente -l 0.0.0.0:5500 +``` + +### Install via Homebrew + +Not yet done. + +### Install via cargo + +Not yet done. + +### Prebuilt releases + +Not yet done. + +## Using as a Library + +Linea caliente is also available to be imported as a library so you can build +your own hotline compatible clients and servers. |