diff options
| author | Ben Busby <noreply+git@benbusby.com> | 2021-11-07 12:29:06 -0700 |
|---|---|---|
| committer | Ben Busby <noreply+git@benbusby.com> | 2021-11-07 12:29:06 -0700 |
| commit | 8042dcad0c61110111949a856c935325ca65f8ef (patch) | |
| tree | 2f3bfb751fd5910fc80383d45e41e85444e0fd4b /README.md | |
| parent | 06bb8403dd64ba51557c48324dbe88b58244e3e8 (diff) | |
| download | farside-8042dcad0c61110111949a856c935325ca65f8ef.tar.gz | |
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.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 13 insertions, 2 deletions
@@ -1,5 +1,16 @@ -# Privacy Revolver +# Farside +FOSS alternative redirecting service [](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 |