Doc: add package docs (#296)

* Doc: add package docs

Add short package level docs to make godoc looks nicer.
Add some badges to the README.

* correct url
This commit is contained in:
Miek Gieben
2016-09-25 08:39:20 +01:00
committed by GitHub
parent edc867fe56
commit de0fa53379
24 changed files with 35 additions and 2 deletions

View File

@@ -1,5 +1,8 @@
# CoreDNS
[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/miekg/coredns)
[![Build Status](https://img.shields.io/travis/miekg/coredns.svg?style=flat-square&label=build)](https://travis-ci.org/miekg/coredns)
CoreDNS is a DNS server that started as a fork of [Caddy](https://github.com/mholt/caddy/). It has the
same model: it chains middleware. In fact it's so similar that CoreDNS is now a server type plugin for
Caddy.