dcrd/sampleconfig/README.md
Dave Collins cecfb5a0b4
multi: Update README.md files for go modules.
This updates the installation and updating section of the README.md
files in the various packages to call out the module they are a part of
and instruct the consumer to use the standard go tooling instead of the
old, and no longer correct, package-based 'go get -u' instructions.
2021-01-22 14:39:23 -06:00

23 lines
982 B
Markdown

sampleconfig
============
[![Build Status](https://github.com/decred/dcrd/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrd/actions)
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/sampleconfig)
Package sampleconfig provides a single function that returns the contents of
the sample configuration file for dcrd. This is provided for tools that perform
automatic configuration and would like to ensure the generated configuration
file not only includes the specifically configured values, but also provides
samples of other configuration options.
## Installation and Updating
This package is part of the `github.com/decred/dcrd` module. Use the standard
go tooling for working with modules to incorporate it.
## License
Package sampleconfig is licensed under the [copyfree](http://copyfree.org) ISC
License.