diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e4831a --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,30 @@ | |||
1 | # Gopher (RFC 1436) Web Proxy | ||
2 | |||
3 | [![Build Status](https://travis-ci.org/prologic/gopherproxy.svg)](https://travis-ci.org/prologic/gopherproxy) | ||
4 | |||
5 | This is a Gopher (RFC 1436) Web Proxy that acts as a gateway into Gopherspace | ||
6 | by proxying standard Web HTTP requests to Gopher requests of the target server. | ||
7 | |||
8 | gopherproxy is written in Go (#golang) using the | ||
9 | [go-gopher](https://github.com/prologic/go-gopher) library. | ||
10 | |||
11 | ## Installation | ||
12 | |||
13 | $ go install github.com/prologic/gopherproxy | ||
14 | |||
15 | ## Usage | ||
16 | |||
17 | ```#!bash | ||
18 | $ gopherproxy | ||
19 | ``` | ||
20 | |||
21 | By default gopherproxy will proxy requests to a locally running Gopher server | ||
22 | on gopher://localhost:70/ -- To change where to proxy to: | ||
23 | |||
24 | ```#!bash | ||
25 | $ gopherproxy -host gopher.floodgap.com | ||
26 | ``` | ||
27 | |||
28 | ## License | ||
29 | |||
30 | MIT | ||