Update README
[bloat] / README
1 bloat - A web client for Mastodon Network[1]
2
3 Features:
4
5 - Does not require JavaScript to display text, images, audio and videos.
6
7
8 Requirements:
9
10 - Go 1.11
11
12
13 Building and Installation:
14
15 Typing make will build the binary 
16 $ make
17
18 Edit the provided config file. See the bloat.conf file for more details.  
19 $ ed bloat.conf
20
21 Run the binary
22 $ ./bloat -f bloat.conf
23
24 You can now access the frontend at http://localhost:8080, which is the default
25 listen address. You can also setup a reverse HTTP proxy to serve the frontend over
26 TLS connection.
27
28
29 License:
30
31 To the extent possible under law, the author have dedicated all copyright and
32 related and neighboring rights to this software to the public domain worldwide.
33 This software is distributed without any warranty.
34
35 You should have received a copy of the CC0 Public Domain Dedication along with
36 this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
37
38
39 [1] https://pleroma.social