diff options
| author | Alex Auvolat <alex@adnab.me> | 2018-07-03 15:42:17 +0200 |
|---|---|---|
| committer | Alex Auvolat <alex@adnab.me> | 2018-07-03 15:42:17 +0200 |
| commit | 8f3009715ee9ccdd7ecb54fea1244a32a29b62c0 (patch) | |
| tree | 416fb96c39effa4217864bb6a93243803ba8edba /README.md | |
| download | shard-8f3009715ee9ccdd7ecb54fea1244a32a29b62c0.tar.gz shard-8f3009715ee9ccdd7ecb54fea1244a32a29b62c0.zip | |
Initialize shard repo with code from somewhere
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7abb1ce --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Shard + +Tests of peer-to-peer stuff. Right now it's a little chat application with replication of message history over peers. Nothing is secure, contrary to the name of the project. + +## Installation + +Download and install [Elixir](https://elixir-lang.org/). + +``` +mix deps.get +mix compile +mix run --no-halt +``` + +P2P port is 4044 by default, can be changed by setting the `$PORT` environment variable. HTTP interface is on port `$PORT`+1000. + |