From ff03a9e7ceec3bffb19880688c3dcef76d368841 Mon Sep 17 00:00:00 2001
From: onyinyang <onyinyang@torproject.org>
Date: Wed, 15 Mar 2023 15:42:04 -0400
Subject: [PATCH] Update README

---
 crates/lox-distributor/README.md | 36 ++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

diff --git a/crates/lox-distributor/README.md b/crates/lox-distributor/README.md
index 3783e31..cbfe60f 100644
--- a/crates/lox-distributor/README.md
+++ b/crates/lox-distributor/README.md
@@ -1,3 +1,35 @@
-# Lox server
+# Lox Distributor
 
-Simply run `cargo run` :)
+The Lox distributor receives resources from [rdsys](https://gitlab.torproject.org/tpo/anti-censorship/rdsys) and writes them to [Lox
+BridgeLines](https://git-crysp.uwaterloo.ca/iang/lox/src/master/src/bridge_table.rs#L42). Concurrently, it receives and responds to requests from [Lox clients](https://gitlab.torproject.org/tpo/anti-censorship/lox/lox-wasm). 
+
+## Configure rdsys stream
+
+A test `config.json` is included for testing on a local instance of rdsys. This
+can be edited to correspond to the desired types of resources and endpoints.
+
+## Test Run
+
+For testing purposes, you will need a running instance of rdsys as well as a running Lox client.
+
+### Run rdsys locally
+
+First clone rdsys from [here](https://gitlab.torproject.org/tpo/anti-censorship/rdsys) then change into the backend directory:
+
+```
+cd rdsys/cmd/backend
+```
+
+Finally run rdsys:
+
+```
+ ./backend --config config.json
+```
+
+### Run Lox Distributor locally
+
+Simply run `cargo run -- config.json` :)
+
+### Run a Lox client locally
+
+First clone lox-wasm from [here](https://gitlab.torproject.org/tpo/anti-censorship/lox/lox-wasm). Follow the instructions in the [README](https://gitlab.torproject.org/tpo/anti-censorship/lox/lox-wasm/-/blob/main/README.md) to build and test the Lox client.