1
0
Fork 0
mirror of https://github.com/benbusby/farside.git synced 2025-06-08 10:26:36 +00:00

update readme

This commit is contained in:
mithereal 2022-07-30 19:07:33 -07:00
parent ca1e96470d
commit b73a8b4a4b
3 changed files with 7 additions and 2 deletions

View file

@ -3,6 +3,7 @@
[![Latest Release](https://img.shields.io/github/v/release/benbusby/farside?label=Release)](https://github.com/benbusby/farside/releases)
[![MIT License](https://img.shields.io/github/license/benbusby/earthbound-themes.svg)](http://opensource.org/licenses/MIT)
[![Elixir CI](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml/badge.svg)](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml)
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
A redirecting service for FOSS alternative frontends.
@ -14,6 +15,10 @@ available public instances for a particular service, while also helping to
distribute traffic more evenly across all instances and avoid performance
bottlenecks and rate-limiting.
## Heroku deploy
To load custom services, you must paste a base64 encoded string into the FARSIDE_SERVICES_JSON field
you can encode your json at https://www.base64encode.org
## Demo
Farside's links work with the following structure: `farside.link/<service>/<path>`