From 8042dcad0c61110111949a856c935325ca65f8ef Mon Sep 17 00:00:00 2001 From: Ben Busby Date: Sun, 7 Nov 2021 12:29:06 -0700 Subject: Refactor project to new name The name of the project is being refactored from Privacy Revolver to Farside. The reasoning behind this is: 1. A shorter name is easier to remember 2. It can stand for "FOSS alternative redirecting service" (which I know doesn't encapsulate all letters from "farside", but it's close enough). This commit also includes improvements to the update script for determining how far along the script is. --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3