Skip to content
This repository was archived by the owner on Apr 20, 2023. It is now read-only.

Commit 0d2297f

Browse files
authored
README: More consistent formatting with other Go packages. (#68)
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.
1 parent af915bf commit 0d2297f

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

‎README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
httpcache
22
=========
33

4-
[![Build Status](https://travis-ci.org/gregjones/httpcache.svg?branch=master)](https://travis-ci.org/gregjones/httpcache)
5-
6-
A Transport for Go's http.Client that will cache responses according to the HTTP RFC
4+
[![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)
75

86
Package httpcache provides a http.RoundTripper implementation that works as a mostly RFC-compliant cache for http responses.
97

108
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).
119

12-
**Documentation:** http://godoc.org/github.com/gregjones/httpcache
13-
14-
**License:** MIT (see LICENSE.txt)
15-
16-
Cache backends
10+
Cache Backends
1711
--------------
1812

1913
- The built-in 'memory' cache stores responses in an in-memory map.
@@ -23,3 +17,8 @@ Cache backends
2317
- [`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).
2418
- [`github.com/die-net/lrucache`](https://github.com/die-net/lrucache) provides an in-memory cache that will evict least-recently used entries.
2519
- [`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.
20+
21+
License
22+
-------
23+
24+
- [MIT License](LICENSE.txt)

0 commit comments

Comments
 (0)