From 3cceb4fab09ed58245a22b279df1d28fee763157 Mon Sep 17 00:00:00 2001 From: Peng Gao Date: Sat, 27 Aug 2016 20:00:58 +0800 Subject: [PATCH] Update README, ci, pa Signed-off-by: Peng Gao --- .pullapprove.yml | 9 +++++++++ .travis.yml | 8 ++++++++ README.md | 17 ++++++++--------- 3 files changed, 25 insertions(+), 9 deletions(-) create mode 100644 .pullapprove.yml create mode 100644 .travis.yml diff --git a/.pullapprove.yml b/.pullapprove.yml new file mode 100644 index 0000000..f72d0cb --- /dev/null +++ b/.pullapprove.yml @@ -0,0 +1,9 @@ +approve_by_comment: true +approve_regex: ^LGTM +reject_regex: ^Rejected +reset_on_push: true +reviewers: + members: + - ggaaooppeenngg + name: pullapprove + required: 1 diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..9305d77 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,8 @@ +language: go + +go: + - tip + +script: + - go test -v -coverprofile=coverage.txt -covermode=atomic + diff --git a/README.md b/README.md index bd47807..8229ebb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -# go-cache +[![Build Status](https://travis-ci.org/ggaaooppeenngg/cachemap.svg?branch=master)](https://travis-ci.org/ggaaooppeenngg/cachemap) +[![Go Report Card](https://goreportcard.com/badge/github.com/ggaaooppeenngg/cachemap)](https://goreportcard.com/report/github.com/ggaaooppeenngg/cachemap) +[![GoDoc](https://godoc.org/github.com/ggaaooppeenngg/cachemap?status.svg)](https://godoc.org/github.com/ggaaooppeenngg/cachemap) +# cachemap -go-cache is an in-memory key:value store/cache similar to memcached that is +cachemap is an in-memory key:value store/cache similar to memcached that is suitable for applications running on a single machine. Its major advantage is that, being essentially a thread-safe `map[string]interface{}` with expiration times, it doesn't need to serialize or transmit its contents over the network. @@ -8,21 +11,21 @@ times, it doesn't need to serialize or transmit its contents over the network. Any object can be stored, for a given duration or forever, and the cache can be safely used by multiple goroutines. -Although go-cache isn't meant to be used as a persistent datastore, the entire +Although cachemap isn't meant to be used as a persistent datastore, the entire cache can be saved to and loaded from a file (using `c.Items()` to retrieve the items map to serialize, and `NewFrom()` to create a cache from a deserialized one) to recover from downtime quickly. (See the docs for `NewFrom()` for caveats.) ### Installation -`go get github.com/patrickmn/go-cache` +`go get github.com/ggaaooppeenngg/cachemap` ### Usage ```go import ( "fmt" - "github.com/patrickmn/go-cache" + "github.com/patrickmn/cachemap" "time" ) @@ -102,10 +105,6 @@ one) to recover from downtime quickly. (See the docs for `NewFrom()` for caveats } ``` -### Reference - -`godoc` or [http://godoc.org/github.com/patrickmn/go-cache](http://godoc.org/github.com/patrickmn/go-cache) - ### Benchmark | benchmark\package | go-cache | cachemap |