summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 88082d7..8d78543 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
-# Privacy Revolver
+# Farside
+FOSS alternative redirecting service
[![Elixir CI](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml/badge.svg)](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml)
-A smart redirecting proxy for privacy-friendly frontends
+A tool for evenly distributing traffic across various open source alternative frontends
+
+### Development
+
+- Install [redis](https://redis.io)
+- Install [elixir](https://elixir-lang.org/install.html)
+- Start redis: `redis-server /usr/local/etc/redis.conf`
+- Install dependencies: `mix deps.get`
+- Initialize redis contents: `mix run update.exs`
+- Run Farside: `mix run --no-halt`
+ - Uses localhost:4001