From fa19101ef879fb425123ac4a9cffe56d7366c86d Mon Sep 17 00:00:00 2001 From: Dmitri Shuralyov Date: Fri, 14 Apr 2017 23:03:02 -0400 Subject: [PATCH 1/2] README: More consistent formatting with other Go packages. Remove the redundant "A Transport for Go's http.Client that will cache responses according to the HTTP RFC" sentence. The next paragraph says something similar. This sentence can already be found in the repository description (one liner). It's very common to find a godoc.org link in the form of a badge in most Go package repository READMEs. Therefore, it's more recognizable and easier to click the link. I think we should use the badge to be friendlier to users, and remove the superseded plain text link. Move License note into its own section at the bottom. This is a more common location. GitHub already detects and displays the license prominently in top right corner, and there is a LICENSE file in the repo, so it makes sense to place Cache Backends section higher up. --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ccd0172..f1a0a76 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,13 @@ httpcache ========= -[![Build Status](https://travis-ci.org/gregjones/httpcache.svg?branch=master)](https://travis-ci.org/gregjones/httpcache) - -A Transport for Go's http.Client that will cache responses according to the HTTP RFC +[![Build Status](https://travis-ci.org/gregjones/httpcache.svg?branch=master)](https://travis-ci.org/gregjones/httpcache) [![GoDoc](https://godoc.org/github.com/gregjones/httpcache?status.svg)](https://godoc.org/github.com/gregjones/httpcache) Package httpcache provides a http.RoundTripper implementation that works as a mostly RFC-compliant cache for http responses. It is only suitable for use as a 'private' cache (i.e. for a web-browser or an API-client and not for a shared proxy). -**Documentation:** http://godoc.org/github.com/gregjones/httpcache - -**License:** MIT (see LICENSE.txt) - -Cache backends +Cache Backends -------------- - The built-in 'memory' cache stores responses in an in-memory map. @@ -23,3 +17,8 @@ Cache backends - [`github.com/gregjones/httpcache/leveldbcache`](https://github.com/gregjones/httpcache/tree/master/leveldbcache) provides a filesystem-backed cache using [leveldb](https://github.com/syndtr/goleveldb/leveldb). - [`github.com/die-net/lrucache`](https://github.com/die-net/lrucache) provides an in-memory cache that will evict least-recently used entries. - [`github.com/die-net/lrucache/twotier`](https://github.com/die-net/lrucache/tree/master/twotier) allows caches to be combined, for example to use lrucache above with a persistent disk-cache. + +License +------- + +- [MIT License](LICENSE) From 9eee50027fdef4b0d439552e74a0227e62f06ac8 Mon Sep 17 00:00:00 2001 From: Dmitri Shuralyov Date: Mon, 24 Apr 2017 16:32:36 -0400 Subject: [PATCH 2/2] README: Fix link to LICENSE.txt. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f1a0a76..61bd830 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,4 @@ Cache Backends License ------- -- [MIT License](LICENSE) +- [MIT License](LICENSE.txt)