add documentation

.gitignore

@@ -0,0 +1 @@
+.idea

config.go

@@ -2,17 +2,20 @@ package fluentio
 
 import "github.com/fluent/fluent-logger-golang/fluent"
 
+// Config is used to configure the Writer.
 type Config struct {
 	fluentConfig *fluent.Config
 	basicConfig  *BasicConfig
 	tag          string
 }
 
+// BasicConfig is used to configure the Writer with a basic configuration.
 type BasicConfig struct {
 	FluentHost string
 	FluentPort int
 }
 
+// WithBasicConfig returns a function that can be used to configure the Writer with a basic configuration.
 func WithBasicConfig(host string, port int) func(*Config) {
 	return func(c *Config) {
 		c.basicConfig = &BasicConfig{
@@ -22,12 +25,14 @@ func WithBasicConfig(host string, port int) func(*Config) {
 	}
 }
 
+// WithFluentConfig returns a function that can be used to configure the Writer with the standard fluent-logger-golang configuration.
 func WithFluentConfig(config *fluent.Config) func(*Config) {
 	return func(c *Config) {
 		c.fluentConfig = config
 	}
 }
 
+// WithTag returns a function that can be used to configure the Writer with a tag.
 func WithTag(tag string) func(*Config) {
 	return func(c *Config) {
 		c.tag = tag

errors.go

@@ -3,5 +3,6 @@ package fluentio
 import "errors"
 
 var (
+	// ErrNoConfigProvided is returned when no configuration is provided.
 	ErrNoConfigProvided = errors.New("no config provided")
 )

fluent.go

@@ -6,13 +6,17 @@ import (
 	"io"
 )
 
+// Writer is an io.Writer that writes to fluentd.
 type Writer struct {
 	client *fluent.Fluent
 	tag    string
 }
 
 var _ io.Writer = (*Writer)(nil)
 
+// New creates a new Writer.
+// It accepts a variadic number of options that can be used to configure the Writer.
+// If no options are provided, it will return an error.
 func New(opts ...func(config *Config)) (*Writer, error) {
 	config := new(Config)
 	for _, opt := range opts {
@@ -56,6 +60,7 @@ func New(opts ...func(config *Config)) (*Writer, error) {
 	}, nil
 }
 
+// Write is the implementation of io.Writer.
 func (f *Writer) Write(p []byte) (n int, err error) {
 	var m map[string]interface{}
 	err = json.Unmarshal(p, &m)