Skip to content
This repository has been archived by the owner on Jul 27, 2021. It is now read-only.

Commit

Permalink
Add documentation for config package
Browse files Browse the repository at this point in the history
  • Loading branch information
achilleasa committed Jan 2, 2017
1 parent 4d5376d commit e88e17b
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions config/config.go
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
// Package config exposes a global configuration store instance and provides
// helpers for setting default configuration values.
//
// Including this package will automatically register the built-in configuration
// providers. For more information please see the provider sub-package.
package config

import (
"github.com/achilleasa/usrv/config/provider"
"github.com/achilleasa/usrv/config/store"
)

var (
// Store is a global configuration store instance that is used to configure
// the various usrv components.
Store store.Store
)
// Store is a global configuration store instance that is used to configure
// the various usrv components. Including the config package automatically
// registers the built-in configuration providers with this store.
var Store store.Store

// SetDefaults updates the global store instance with the default values for a
// particular configuration path.
Expand Down

0 comments on commit e88e17b

Please sign in to comment.