aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFeuerfuchs <git@feuerfuchs.dev>2019-06-26 21:51:25 +0200
committerFeuerfuchs <git@feuerfuchs.dev>2019-06-26 21:51:25 +0200
commit2986f020c87a69224233292969d817de6155e658 (patch)
treee012e5d2b60ece9c38ee8dff8b0a527fe6dfdf17 /README.md
parentFix URL regex for ending slashes (diff)
downloadgopherproxy-2986f020c87a69224233292969d817de6155e658.tar.gz
gopherproxy-2986f020c87a69224233292969d817de6155e658.tar.bz2
gopherproxy-2986f020c87a69224233292969d817de6155e658.zip
Code cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 29 insertions, 22 deletions
diff --git a/README.md b/README.md
index 4b89136..49ed7c5 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,51 @@
1# Gopher (RFC 1436) Web Proxy 1# Gopher (RFC 1436) Web Proxy
2 2
3[![Build Status](https://cloud.drone.io/api/badges/prologic/gopherproxy/status.svg)](https://cloud.drone.io/prologic/gopherproxy)
4[![CodeCov](https://codecov.io/gh/prologic/gopherproxy/branch/master/graph/badge.svg)](https://codecov.io/gh/prologic/gopherproxy)
5[![Go Report Card](https://goreportcard.com/badge/prologic/gopherproxy)](https://goreportcard.com/report/prologic/gopherproxy)
6[![GoDoc](https://godoc.org/git.feuerfuchs.dev/Feuerfuchs/gopherproxy?status.svg)](https://godoc.org/git.feuerfuchs.dev/Feuerfuchs/gopherproxy)
7[![Sourcegraph](https://sourcegraph.com/git.feuerfuchs.dev/Feuerfuchs/gopherproxy/-/badge.svg)](https://sourcegraph.com/git.feuerfuchs.dev/Feuerfuchs/gopherproxy?badge)
8
9gopherproxy is a Gopher (RFC 1436) Web Proxy that acts as a gateway into Gopherspace 3gopherproxy is a Gopher (RFC 1436) Web Proxy that acts as a gateway into Gopherspace
10by proxying standard Web HTTP requests to Gopher requests of the target server. 4by proxying standard Web HTTP requests to Gopher requests of the target server.
11 5
12gopherproxy is written in Go (#golang) using the 6gopherproxy is a fork of https://github.com/prologic/gopherproxy.
13[go-gopher](https://github.com/prologic/go-gopher) library. 7
8Demo: https://gopher.feuerfuchs.dev/
9
10
11## Requirements
12
13gopherproxy requires the following programs and libraries:
14
15- libvips: Fast on-demand thumbnail generation
14 16
15Demo: https://gopher.mills.io/
16 17
17## Installation 18## Installation
18 19
19 $ go install git.feuerfuchs.dev/Feuerfuchs/gopherproxy/... 20 $ go install git.feuerfuchs.dev/Feuerfuchs/gopherproxy/...
20 21
21### Docker
22 22
23Run directly from a prebuild image from the [Docker Hub](https://hub.docker.com): 23## Usage
24 24
25```#!bash 25```#!bash
26$ docker run -p 8000:8000 prologic/gopherproxy 26$ gopherproxy
27``` 27```
28 28
29Or build your own custom image from a source checkout: 29Then simply visit: http://localhost:8000/
30 30
31```#!bash
32$ docker build -t gopherproxy .
33$ docker run -p 80:80 gopherproxy -uri floodgap.com
34```
35 31
36## Usage 32## Development
37 33
38```#!bash 34For development, the following libraries and programs are required in addition
39$ gopherproxy 35to the previously listed ones:
40``` 36
37- **SASS (sassc):** Compiling SCSS to CSS
38- **TypeScript (tsc):** Compiling TypeScript to JavaScript
39- **UglifyJS (uglifyjs):** Minifying JavaScript
40- **fonttools (pyftsubset):** Minifying fonts
41
42Folder structure:
43
44- **assets:** Compiled assets that will be embedded into the executable using packr
45- **css:** SCSS source files
46- **fonts:** Fonts that will be minified
47- **js:** TypeScript source files
41 48
42Then simply visit: http://localhost/gopher.floodgap.com
43 49
44## Related 50## Related
45 51
@@ -52,6 +58,7 @@ Related projects:
52 gopherclient is a cross-platform QT/QML GUI Gopher Client 58 gopherclient is a cross-platform QT/QML GUI Gopher Client
53 using the gopherproxy library as its backend. 59 using the gopherproxy library as its backend.
54 60
61
55## License 62## License
56 63
57MIT 64MIT