diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml index 9095fde..5e76756 100644 --- a/.github/workflows/pipeline.yml +++ b/.github/workflows/pipeline.yml @@ -1,5 +1,22 @@ -# This workflow will build a golang project -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go +# Copyright (c) 2024 Maxtek Consulting +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. name: Keybase CI Pipeline @@ -35,4 +52,4 @@ jobs: uses: codecov/codecov-action@v4.0.1 with: token: ${{ secrets.CODECOV_TOKEN }} - slug: maxtek6/endpoints-go \ No newline at end of file + slug: maxtek6/keybase-go \ No newline at end of file diff --git a/README.md b/README.md index eb8cd31..707366d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Keybase +[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](http://pkg.go.dev/github.com/maxtek6/keybase-go) +[![codecov](https://codecov.io/gh/maxtek6/keybase-go/branch/master/graph/badge.svg)](https://codecov.io/gh/maxtek6/keybase-go) +[![Go Report Card](https://goreportcard.com/badge/github.com/maxtek6/keybase-go)](https://goreportcard.com/report/github.com/maxtek6/keybase-go) + Keybase is a key counting database with expiring keys and optional persistence. ## Usage @@ -38,4 +42,9 @@ _ = kb.PruneEntries(context.TODO()) ``` This will remove the stale keys and reduce the amount of storage required by memory or -filesystem. \ No newline at end of file +filesystem. When the keybase is no longer needed, it needs to be disconnected using the +`Close()` function: + +```go +kb.Close() +``` \ No newline at end of file