f0a01ced0a
This adds a readme and doc.go for the sampleconfig package so it is consistent with all of the other packages. While here, it also changes the exported value to a constant and removes the unused sampleConfigFilename constant.
24 lines
880 B
Markdown
24 lines
880 B
Markdown
sampleconfig
|
|
============
|
|
|
|
[](https://travis-ci.org/decred/dcrd)
|
|
[](http://copyfree.org)
|
|
[](http://godoc.org/github.com/decred/dcrd/sampleconfig)
|
|
|
|
Package sampleconfig provides a single constant that contains 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
|
|
|
|
```bash
|
|
$ go get -u github.com/decred/dcrd/sampleconfig
|
|
```
|
|
|
|
## License
|
|
|
|
Package sampleconfig is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|