Update readme
[bloat] / README
1 Web - 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 External dependencies:
14
15 - Fork of go-masodon (https://github.com/mattn/go-mastodon)
16 - gorilla/mux (https://github.com/gorilla/mux)
17
18
19 Building and Installation:
20
21 Make sure you have GO installed. Other dependencies will be downloaded 
22 automatically.
23
24 Typing make will build the binary 
25 $ make
26
27 Edit the provided config file. See the default.conf file for more details.  
28 $ ed default.conf
29
30 Run the binary
31 $ ./web
32
33 You can now access the frontend at http://localhost:8080, which is the default
34 listen address. You can also setup a reverse HTTP proxy to serve the frontend over
35 TLS connection.
36
37
38 Notes:
39
40 A database reset is required after changing the values of config options client_name,
41 client_scope or client_website.
42
43
44 License:
45
46 To the extent possible under law, the author have dedicated all copyright and
47 related and neighboring rights to this software to the public domain worldwide.
48 This software is distributed without any warranty.
49
50 You should have received a copy of the CC0 Public Domain Dedication along with
51 this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.
52
53
54 [1] https://pleroma.social