From e8305cc7f1a459482ea255bc06c574bedfb92848 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C2=A0Ilya=20Atamas?= Date: Mon, 22 Apr 2019 19:36:03 +0300 Subject: [PATCH] docs: extend docs --- proxy/doc.go | 5 ----- proxy/{main.go => proxy.go} | 6 +++++- proxy/server.go | 1 + 3 files changed, 6 insertions(+), 6 deletions(-) delete mode 100644 proxy/doc.go rename proxy/{main.go => proxy.go} (76%) diff --git a/proxy/doc.go b/proxy/doc.go deleted file mode 100644 index 8888271..0000000 --- a/proxy/doc.go +++ /dev/null @@ -1,5 +0,0 @@ -// -// Package proxy implements a HTTP caching proxy for Node package registry (NPM). -// See https://github.com/emeralt/npm-cache-proxy/ for more information about proxy. -// -package proxy // import "https://github.com/emeralt/npm-cache-proxy/proxy" diff --git a/proxy/main.go b/proxy/proxy.go similarity index 76% rename from proxy/main.go rename to proxy/proxy.go index c45400b..b5d554a 100644 --- a/proxy/main.go +++ b/proxy/proxy.go @@ -1,4 +1,8 @@ -package proxy +// +// Package proxy implements a HTTP caching proxy for Node package registry (NPM). +// See https://github.com/emeralt/npm-cache-proxy/ for more information about proxy. +// +package proxy // import "https://github.com/emeralt/npm-cache-proxy/proxy" import ( "net/http" diff --git a/proxy/server.go b/proxy/server.go index 16cd38e..fc917c3 100644 --- a/proxy/server.go +++ b/proxy/server.go @@ -9,6 +9,7 @@ import ( zap "go.uber.org/zap" ) +// ServerOptions provides configuration for Server method type ServerOptions struct { ListenAddress string }