From 2986f020c87a69224233292969d817de6155e658 Mon Sep 17 00:00:00 2001
From: Feuerfuchs <git@feuerfuchs.dev>
Date: Wed, 26 Jun 2019 21:51:25 +0200
Subject: Code cleanup

---
 README.md | 51 +++++++++++++++++++++++++++++----------------------
 1 file changed, 29 insertions(+), 22 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 4b89136..49ed7c5 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,51 @@
 # Gopher (RFC 1436) Web Proxy
 
-[![Build Status](https://cloud.drone.io/api/badges/prologic/gopherproxy/status.svg)](https://cloud.drone.io/prologic/gopherproxy)
-[![CodeCov](https://codecov.io/gh/prologic/gopherproxy/branch/master/graph/badge.svg)](https://codecov.io/gh/prologic/gopherproxy)
-[![Go Report Card](https://goreportcard.com/badge/prologic/gopherproxy)](https://goreportcard.com/report/prologic/gopherproxy)
-[![GoDoc](https://godoc.org/git.feuerfuchs.dev/Feuerfuchs/gopherproxy?status.svg)](https://godoc.org/git.feuerfuchs.dev/Feuerfuchs/gopherproxy) 
-[![Sourcegraph](https://sourcegraph.com/git.feuerfuchs.dev/Feuerfuchs/gopherproxy/-/badge.svg)](https://sourcegraph.com/git.feuerfuchs.dev/Feuerfuchs/gopherproxy?badge)
-
 gopherproxy is a Gopher (RFC 1436) Web Proxy that acts as a gateway into Gopherspace
 by proxying standard Web HTTP requests to Gopher requests of the target server.
 
-gopherproxy is written in Go (#golang) using the
-[go-gopher](https://github.com/prologic/go-gopher) library.
+gopherproxy is a fork of https://github.com/prologic/gopherproxy.
+
+Demo: https://gopher.feuerfuchs.dev/
+
+
+## Requirements
+
+gopherproxy requires the following programs and libraries:
+
+- libvips: Fast on-demand thumbnail generation
 
-Demo: https://gopher.mills.io/
 
 ## Installation
   
   $ go install git.feuerfuchs.dev/Feuerfuchs/gopherproxy/...
 
-### Docker
 
-Run directly from a prebuild image from the [Docker Hub](https://hub.docker.com):
+## Usage
 
 ```#!bash
-$ docker run -p 8000:8000 prologic/gopherproxy
+$ gopherproxy
 ```
 
-Or build your own custom image from a source checkout:
+Then simply visit: http://localhost:8000/
 
-```#!bash
-$ docker build -t gopherproxy .
-$ docker run -p 80:80 gopherproxy -uri floodgap.com
-```
 
-## Usage
+## Development
 
-```#!bash
-$ gopherproxy
-```
+For development, the following libraries and programs are required in addition
+to the previously listed ones:
+
+- **SASS (sassc):** Compiling SCSS to CSS
+- **TypeScript (tsc):** Compiling TypeScript to JavaScript
+- **UglifyJS (uglifyjs):** Minifying JavaScript
+- **fonttools (pyftsubset):** Minifying fonts
+
+Folder structure:
+
+- **assets:** Compiled assets that will be embedded into the executable using packr
+- **css:** SCSS source files
+- **fonts:** Fonts that will be minified
+- **js:** TypeScript source files
 
-Then simply visit: http://localhost/gopher.floodgap.com
 
 ## Related
 
@@ -52,6 +58,7 @@ Related projects:
   gopherclient is a cross-platform QT/QML GUI Gopher Client
   using the gopherproxy library as its backend.
 
+
 ## License
 
 MIT
-- 
cgit v1.2.3-54-g00ecf