diff --git a/README.md b/README.md index fffb0f7b..abd0164f 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,34 @@ -btcutil +bglutil ======= -[![Build Status](https://github.com/btcsuite/btcutil/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcutil/actions) +[![Build Status](https://github.com/BitgesellOfficial/bglutil/actions/workflows/go.yml/badge.svg)](https://github.com/BitgesellOfficial/bglutil/actions/workflows/go.yml) [![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) -[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/btcsuite/btcutil) +[![Go Reference](https://pkg.go.dev/badge/github.com/bitgesellofficial/bglutil.svg)](https://pkg.go.dev/github.com/bitgesellofficial/bglutil) -Package btcutil provides bitcoin-specific convenience functions and types. +Package bglutil provides Bitgesell-specific convenience functions and types. A comprehensive suite of tests is provided to ensure proper functionality. See `test_coverage.txt` for the gocov coverage report. Alternatively, if you are running a POSIX OS, you can run the `cov_report.sh` script for a real-time report. -This package was developed for btcd, an alternative full-node implementation of -bitcoin which is under active development by Conformal. Although it was -primarily written for btcd, this package has intentionally been designed so it -can be used as a standalone package for any projects needing the functionality -provided. +This package is maintained for Bitgesell projects and can also be used as a +standalone package for projects needing the utility functionality provided. ## Installation and Updating ```bash -$ go get -u github.com/btcsuite/btcutil +$ go get -u github.com/bitgesellofficial/bglutil ``` -## GPG Verification Key +## Development -All official release tags are signed by Conformal so users can ensure the code -has not been tampered with and is coming from the btcsuite developers. To -verify the signature perform the following: +Run the package test suite with: -- Download the public key from the Conformal website at - https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt - -- Import the public key into your GPG keyring: - ```bash - gpg --import GIT-GPG-KEY-conformal.txt - ``` - -- Verify the release tag with the following command where `TAG_NAME` is a - placeholder for the specific tag: - ```bash - git tag -v TAG_NAME - ``` +```bash +$ go test ./... +``` ## License -Package btcutil is licensed under the [copyfree](http://copyfree.org) ISC +Package bglutil is licensed under the [copyfree](http://copyfree.org) ISC License.