initial commit

README.md

@@ -0,0 +1,55 @@
+# Nexy - Multi-network server for the [Nex protocol](https://nex.nightfall.city/nex/info/specification.txt)
+
+![Build](https://github.com/yggverse/server/actions/workflows/build.yml/badge.svg)
+[![Dependencies](https://deps.rs/repo/github/yggverse/server/status.svg)](https://deps.rs/repo/github/yggverse/nexy)
+[![crates.io](https://img.shields.io/crates/v/nexy)](https://crates.io/crates/nexy)
+
+Run server accessible to Internet IPv4/IPv6, [Yggdrasil](https://yggdrasil-network.github.io/), [Mycelium](https://github.com/threefoldtech/mycelium), and other networks simultaneously, as many as desired.
+
+## Install
+
+1. `git clone https://github.com/yggverse/nexy.git && cd nexy`
+2. `cargo build --release`
+3. `sudo install target/release/nexy /usr/local/bin/nexy`
+
+## Usage
+
+``` bash
+nexy -p /path/to/public
+```
+* by default, server starts on localhost; change it with the `--bind` option(s)
+
+### Options
+
+``` bash
+-b, --bind <BIND>
+        Bind server(s) `host:port` to listen incoming connections
+
+        * use `[host]:port` notation for IPv6
+
+        [default: 127.0.0.1:1900 [::1]:1900]
+
+-d, --debug <DEBUG>
+        Debug level
+
+        * `e` - error * `i` - info
+
+        [default: ei]
+
+-t, --template <TEMPLATE>
+        Absolute path to the template files directory
+
+-p, --public <PUBLIC>
+        Absolute path to the public files directory
+
+-r, --read-chunk <READ_CHUNK>
+        Optimize memory usage on reading large files or stream
+
+        [default: 1024]
+
+-h, --help
+        Print help (see a summary with '-h')
+
+-V, --version
+        Print version
+```