feat: initial documentation and interface thoughts

Makefile

@@ -0,0 +1,5 @@
+ifndef GODOCPORT
+godoc: GODOCPORT = 8080
+endif
+godoc:
+	godoc -http=:$(GODOCPORT)

doc.go

@@ -0,0 +1,34 @@
+// Package gofig provides a library for loading configuration into a struct type. It also provides
+// notification functionality (for parsers supporting it) for when configuration changes whilst the
+// application is running, allowing you to hot reload your application when configuration changes.
+//
+// At it's core Gofig takes no 3rd party dependencies, parsers are implemented as their own sub
+// modules, which may take 3rd party dependencies so you only get what you decide to use.
+//
+// Gofig It aims to provide a simple set of interfaces and API's to make it easy for users to implement
+// their own parsers beyond those bundled within the parsers package.
+//
+// Example.
+//
+//   package main
+//
+//   import (
+//       "go.krak3n.codes/gofig"
+//       "go.krak3n.codes/gofig/parsers/toml" // because why aren't you using TOML?
+//   )
+//
+//   type MyConfig struct {
+//       Foo string `gofig:"foo"`
+//       Bar string `gofig:"bar"`
+//   }
+//
+//   func main() {
+//       var cfg MyConfig
+//
+//       // gofig.Must will panic on error
+//       fig := gofig.Must(gofig.New(&cfg))
+//       gofig.Must(fig.Parse(toml.File("/path/to/my/config.toml")))
+//
+//       // Use your config
+//   }
+package gofig

go.mod

@@ -0,0 +1,3 @@
+module go.krak3n.codes/gofig
+
+go 1.13

gofig.go

@@ -0,0 +1,23 @@
+package gofig
+
+// Gofig default configuration.
+const (
+	DefaultStructTag = "gofig"
+)
+
+// A Parser parses configuration.
+type Parser interface {
+	Parse() error
+}
+
+// A Notifier notifies via a channel if changes to configuration have occurred.
+// Remember to check the error on the channel.
+type Notifier interface {
+	Notify() <-chan error
+}
+
+// A ParseNotifier can parse config and notify on changes to configuration.
+type ParseNotifier interface {
+	Parser
+	Notifier
+}

parsers/json/go.mod

@@ -0,0 +1,3 @@
+module go.krak3n.codes/gofig/parsers/json
+
+go 1.13

parsers/json/json.go

@@ -0,0 +1 @@
+package json

parsers/toml/go.mod

@@ -0,0 +1,3 @@
+module go.krak3n.codes/gofig/parsers/toml
+
+go 1.13

parsers/toml/toml.go

@@ -0,0 +1 @@
+package toml

parsers/yaml/go.mod

@@ -0,0 +1,3 @@
+module go.krak3n.codes/gofig/parsers/yaml
+
+go 1.13

parsers/yaml/yaml.go

@@ -0,0 +1 @@
+package yaml