From a3d0c9bf315d7331f99080bc4509f1a2e077672a Mon Sep 17 00:00:00 2001 From: r Date: Wed, 1 Jan 2020 11:39:46 +0000 Subject: [PATCH] Update readme --- README | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README b/README index 817f818..d0e11dd 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -Web - A web client for Mastodon Network +Web - A web client for Mastodon Network[1] Features: @@ -18,24 +18,26 @@ External dependencies: Building and Installation: -Make sure you have GO installed. Other dependencies will be -downloaded automatically. +Make sure you have GO installed. Other dependencies will be downloaded +automatically. Typing make will build the binary $ make -Edit the provided config file. See the default.conf file for more details. +Edit the provided config file. See the default.conf file for more details. $ ed default.conf Run the binary $ ./web -You can also setup a reverse HTTP proxy serve the website over TLS connection. +You can now access the frontend at http://localhost:8080, which is the default +listen address. You can also setup a reverse HTTP proxy to serve the frontend over +TLS connection. Notes: -You will need to clear the database if you change config values for client_name, +A database reset is required after changing the values of config options client_name, client_scope or client_website. @@ -46,4 +48,7 @@ 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 . +this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/. + + +[1] https://pleroma.social