* changed license, doc enhancements, upgr deps, go min ver 1.17

actforgood · Sep 16, 2022 · f22b264 · f22b264
1 parent 0006bc6
commit f22b264
Show file tree

Hide file tree

Showing 37 changed files with 597 additions and 92 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [1.16.x, 1.17.x, 1.18.x, 1.19.x]
+        go-version: [1.17.x, 1.18.x, 1.19.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
 
@@ -51,7 +51,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [1.16.x, 1.17.x, 1.18.x, 1.19.x]
+        go-version: [1.17.x, 1.18.x, 1.19.x]
 
     services:
       redis6:

diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,3 @@
+# This is the official list of actforgood/xcache authors for copyright purposes.
+
+Bogdan Constantinescu (https://github.com/bogcon)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Bogdan Constantinescu
+Copyright (c) 2022 The ActForGood Authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -10,6 +10,12 @@
 Package `xcache` offers caching alternatives for an application like a local in memory cache,
 or distributed Redis cache, or combination of those two in a multi layered cache.
 
+### Installation
+
+```shell
+$ go get -u github.com/actforgood/xcache
+```
+
 
 ### Cache adapters
 - `Memory` - a local in memory cache, relies upon Freecache package.  

diff --git a/assert_test.go b/assert_test.go
@@ -1,7 +1,7 @@
-// Copyright 2022 Bogdan Constantinescu.
+// Copyright The ActForGood Authors.
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
-// https://github.com/actforgood/xcache/LICENSE.
+// https://github.com/actforgood/xcache/blob/main/LICENSE.
 
 package xcache_test
 

diff --git a/bench_common_test.go b/bench_common_test.go
@@ -1,7 +1,7 @@
-// Copyright 2022 Bogdan Constantinescu.
+// Copyright The ActForGood Authors.
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
-// https://github.com/actforgood/xcache/LICENSE.
+// https://github.com/actforgood/xcache/blob/main/LICENSE.
 
 package xcache_test
 

diff --git a/build/Dockerfile.benchmark.local b/build/Dockerfile.benchmark.local
@@ -1,4 +1,4 @@
-FROM golang:1.19.0-alpine3.16
+FROM golang:1.19.1-alpine3.16
 
 LABEL maintainer="Bogdan Constantinescu"
 LABEL description="Benchmark Runner for XCache"

diff --git a/build/Dockerfile.test.local b/build/Dockerfile.test.local
@@ -1,4 +1,4 @@
-FROM golang:1.19.0-alpine3.16
+FROM golang:1.19.1-alpine3.16
 
 LABEL maintainer="Bogdan Constantinescu"
 LABEL description="Test Runner for XCache"

diff --git a/cache.go b/cache.go
@@ -1,7 +1,7 @@
-// Copyright 2022 Bogdan Constantinescu.
+// Copyright The ActForGood Authors.
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
-// https://github.com/actforgood/xcache/LICENSE.
+// https://github.com/actforgood/xcache/blob/main/LICENSE.
 
 package xcache
 

diff --git a/common_test.go b/common_test.go
@@ -1,7 +1,7 @@
-// Copyright 2022 Bogdan Constantinescu.
+// Copyright The ActForGood Authors.
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
-// https://github.com/actforgood/xcache/LICENSE.
+// https://github.com/actforgood/xcache/blob/main/LICENSE.
 
 package xcache_test
 

diff --git a/doc.go b/doc.go
@@ -1,7 +1,7 @@
-// Copyright 2022 Bogdan Constantinescu.
+// Copyright The ActForGood Authors.
 // Use of this source code is governed by an MIT-style
 // license that can be found in the LICENSE file or at
-// https://github.com/actforgood/xcache/LICENSE.
+// https://github.com/actforgood/xcache/blob/main/LICENSE.
 
 // Package xcache offers caching alternatives for an application like a local in memory cache,
 // or distributed Redis cache, or combination of those two in a multi layered cache.

diff --git a/go.mod b/go.mod
@@ -1,12 +1,40 @@
 module github.com/actforgood/xcache
 
-go 1.16
+go 1.17
 
 require (
-	github.com/actforgood/xconf v1.1.0
-	github.com/actforgood/xerr v1.0.0
-	github.com/actforgood/xlog v1.1.0
+	github.com/actforgood/xconf v1.2.0
+	github.com/actforgood/xerr v1.1.0
+	github.com/actforgood/xlog v1.2.0
 	github.com/coocood/freecache v1.2.2
 	github.com/go-redis/redis/v8 v8.11.5
 	github.com/go-redis/redis/v9 v9.0.0-beta.2
 )
+
+require (
+	github.com/cespare/xxhash/v2 v2.1.2 // indirect
+	github.com/coreos/go-semver v0.3.0 // indirect
+	github.com/coreos/go-systemd/v22 v22.4.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+	github.com/getsentry/sentry-go v0.13.0 // indirect
+	github.com/go-logfmt/logfmt v0.5.1 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/joho/godotenv v1.4.0 // indirect
+	github.com/magiconair/properties v1.8.6 // indirect
+	github.com/spf13/cast v1.5.0 // indirect
+	go.etcd.io/etcd/api/v3 v3.5.5 // indirect
+	go.etcd.io/etcd/client/pkg/v3 v3.5.5 // indirect
+	go.etcd.io/etcd/client/v3 v3.5.5 // indirect
+	go.uber.org/atomic v1.10.0 // indirect
+	go.uber.org/multierr v1.8.0 // indirect
+	go.uber.org/zap v1.23.0 // indirect
+	golang.org/x/net v0.0.0-20220909164309-bea034e7d591 // indirect
+	golang.org/x/sys v0.0.0-20220915200043-7b5979e65e41 // indirect
+	golang.org/x/text v0.3.7 // indirect
+	google.golang.org/genproto v0.0.0-20220916134934-764224ccc2d1 // indirect
+	google.golang.org/grpc v1.49.0 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# This is the official list of actforgood/xcache authors for copyright purposes.

		Bogdan Constantinescu (https://github.com/bogcon)