summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorMatthew Holt <[email protected]>2015-04-28 12:07:37 -0600
committerMatthew Holt <[email protected]>2015-04-28 12:07:37 -0600
commit78e6d7db95db8ba7862b29c2ce467da046be92c8 (patch)
tree3b42fb47a7a6b41f1d8bbdd65635ca035bffb703 /README.md
parent2cf06bc3eeab0196bb51818d858123cc711deeb6 (diff)
downloadcaddy-78e6d7db95db8ba7862b29c2ce467da046be92c8.tar.gz
caddy-78e6d7db95db8ba7862b29c2ce467da046be92c8.zip
Clarified "no dependencies"; info about 3rd party libraries
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index c11dc7750..4f3be6709 100644
--- a/README.md
+++ b/README.md
@@ -24,13 +24,11 @@ The most notable features are HTTP/2, Virtual Hosts, TLS + SNI, and easy configu
## Getting Caddy
-Caddy binaries are available for nearly every platform and has no dependencies.
+Caddy binaries have no dependencies and are available for nearly every platform.
[Latest release](https://github.com/mholt/caddy/releases/latest)
-
-
## Running from Source
1. `$ go get github.com/mholt/caddy`
@@ -44,8 +42,16 @@ By default, Caddy serves the current directory at [localhost:2015](http://localh
Caddy accepts some flags from the command line. Run `caddy -h` to view the help for flags.
+#### 3rd-party libraries
+
+Although Caddy's binaries are completely static, Caddy relies on some excellent libraries that really make the project possible.
+- [bradfitz/http2](https://github.com/bradfitz/http2) for HTTP/2 support
+- [russross/blackfriday](https://github.com/russross/blackfriday) for Markdown rendering
+- [dustin/go-humanize](https://github.com/dustin/go-humanize) for pleasant times and sizes
+- [flynn/go-shlex](https://github.com/flynn/go-shlex) to parse shell commands properly
+This list may not be comprehensive, but [godoc.org](https://godoc.org/github.com/mholt/caddy) will list all packages that any given package imports.
## Quick Start