update readme

master
alyssa rose 2 years ago committed by alyssa
parent 44ca9a290e
commit d58c0b63f1
  1. 38
      README
  2. 9
      README.md

@ -1,38 +0,0 @@
bloat - A web client for Mastadon Network[1]
Features:
- Does not require JavaScript to display text, images, audio and videos.
Requirements:
- Go 1.11
Building and Installation:
Typing make will build the binary
$ make
Edit the provided config file. See the bloat.conf file for more details.
$ ed bloat.conf
Run the binary
$ ./bloat -f bloat.conf
You can now access the frontend at http://127.0.0.1:8080, which is the default
listen address. See the INSTALL file for more details.
License:
To the extent possible under law, the author have dedicated all copyright and
related and neighboring rights to this software to the public domain worldwide.
This software is distributed without any warranty.
You should have received a copy of the CC0 Public Domain Dedication along with
this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
[1] https://pleroma.social

@ -0,0 +1,9 @@
this is my fork of r's [bloatfe](https://git.freesoftwareextremist.com/bloat) - it's a lightweight web client for mastodon/pleroma, two commonly used ActivityPub servers.
other than a couple layout tweaks, it adds the following features:
* render mastodon-style "spoilers" / content warnings
* route network traffic through a socks5 proxy
if you want to run it for yourself, see INSTALL file for r's original instructions.
<br>you probably don't have a socks proxy running on port 8080 on your local machine, so comment out lines 41-45 in main.go or set the url on line 41 to a valid proxy url.
Loading…
Cancel
Save