Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
donutloop committed Nov 24, 2018
1 parent 880c03b commit 94090f8
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,27 @@

An HTTP server that proxies all requests to other HTTP servers and this servers caches all incoming responses objects

# Installation
## Backend Requirements

* [golang](https://golang.org/) - The Go Programming Language

## Prepare GO development environment

Follow [install guide](https://golang.org/doc/install) to install golang.

## Build

```bash
go get github.com/donutloop/httpcache
mkdir -p $GOPATH/src/github.com/donutloop/ && cd $GOPATH/src/github.com/donutloop/

git clone git@github.com:donutloop/httpcache.git

cd httpcache

go build ./cmd/httpcache
```

# Usage
## Usage

```bash
USAGE
Expand All @@ -20,7 +34,9 @@ USAGE
FLAGS
-cap 100 capacity of cache
-cert server.crt TLS certificate
-expire 5 the items in the cache expire after or expire never
-http :80 serve HTTP on this address (optional)
-key server.key TLS key
-rbcl 524288000 response size limit
-tls serve TLS on this address (optional)
```

0 comments on commit 94090f8

Please sign in to comment.